<?php /** * @package cms * @subpackage controllers */ class CMSPageHistoryController extends CMSMain { static $url_segment = 'pages/history'; static $url_rule = '/$Action/$ID/$VersionID/$OtherVersionID'; static $url_priority = 42; static $menu_title = 'History'; static $required_permission_codes = 'CMS_ACCESS_CMSMain'; static $session_namespace = 'CMSMain'; static $allowed_actions = array( 'VersionsForm', 'compare' ); public static $url_handlers = array( '$Action/$ID/$VersionID/$OtherVersionID' => 'handleAction' ); public function getResponseNegotiator() { $negotiator = parent::getResponseNegotiator(); $controller = $this; $negotiator->setCallback('CurrentForm', function() use(&$controller) { $form = $controller->ShowVersionForm($controller->getRequest()->param('VersionID')); if($form) return $form->forTemplate(); else return $controller->renderWith($controller->getTemplatesWithSuffix('_Content')); }); $negotiator->setCallback('default', function() use(&$controller) { return $controller->renderWith($controller->getViewer('show')); }); return $negotiator; } /** * @return array */ public function show($request) { $form = $this->ShowVersionForm($request->param('VersionID')); $negotiator = $this->getResponseNegotiator(); $controller = $this; $negotiator->setCallback('CurrentForm', function() use(&$controller, &$form) { return $form ? $form->forTemplate() : $controller->renderWith($controller->getTemplatesWithSuffix('_Content')); }); $negotiator->setCallback('default', function() use(&$controller, &$form) { return $controller->customise(array('EditForm' => $form))->renderWith($controller->getViewer('show')); }); return $negotiator->respond($request); } /** * @return array */ public function compare($request) { $form = $this->CompareVersionsForm( $request->param('VersionID'), $request->param('OtherVersionID') ); $negotiator = $this->getResponseNegotiator(); $controller = $this; $negotiator->setCallback('CurrentForm', function() use(&$controller, &$form) { return $form ? $form->forTemplate() : $controller->renderWith($controller->getTemplatesWithSuffix('_Content')); }); $negotiator->setCallback('default', function() use(&$controller, &$form) { return $controller->customise(array('EditForm' => $form))->renderWith($controller->getViewer('show')); }); return $negotiator->respond($request); } /** * Returns the read only version of the edit form. Detaches all {@link FormAction} * instances attached since only action relates to revert. * * Permission checking is done at the {@link CMSMain::getEditForm()} level. * * @param int $id ID of the record to show * @param array $fields optional * @param int $versionID * @param int $compare Compare mode * * @return Form */ public function getEditForm($id = null, $fields = null, $versionID = null, $compareID = null) { if(!$id) $id = $this->currentPageID(); $record = $this->getRecord($id, $versionID); $versionID = ($record) ? $record->Version : $versionID; $form = parent::getEditForm($record, ($record) ? $record->getCMSFields() : null); // Respect permission failures from parent implementation if(!($form instanceof Form)) return $form; $nav = new SilverStripeNavigatorItem_ArchiveLink($record); $form->setActions(new FieldList( $revert = FormAction::create('doRollback', _t('CMSPageHistoryController.REVERTTOTHISVERSION', 'Revert to this version'))->setUseButtonTag(true), $navField = new LiteralField('ArchivedLink', $nav->getHTML()) )); $fields = $form->Fields(); $fields->removeByName("Status"); $fields->push(new HiddenField("ID")); $fields->push(new HiddenField("Version")); $fields = $fields->makeReadonly(); $navField->setAllowHTML(true); if($compareID) { $link = Controller::join_links( $this->Link('show'), $id ); $view = _t('CMSPageHistoryController.VIEW',"view"); $message = _t( 'CMSPageHistoryController.COMPARINGVERSION', "Comparing versions {version1} and {version2}.", array( 'version1' => sprintf('%s (<a href="%s">%s</a>)', $versionID, Controller::join_links($link, $versionID), $view), 'version2' => sprintf('%s (<a href="%s">%s</a>)', $compareID, Controller::join_links($link, $compareID), $view) ) ); $revert->setReadonly(true); } else { $message = _t( 'CMSPageHistoryController.VIEWINGVERSION', "Currently viewing version {version}.", array('version' => $versionID) ); } $fields->addFieldToTab('Root.Main', new LiteralField('CurrentlyViewingMessage', $this->customise(array( 'Content' => $message, 'Classes' => 'notice' ))->renderWith(array('CMSMain_notice'))), "Title" ); $form->setFields($fields->makeReadonly()); $form->loadDataFrom(array( "ID" => $id, "Version" => $versionID, )); if(($record && $record->isLatestVersion())) { $revert->setReadonly(true); } $form->removeExtraClass('cms-content'); return $form; } /** * Version select form. Main interface between selecting versions to view * and comparing multiple versions. * * Because we can reload the page directly to a compare view (history/compare/1/2/3) * this form has to adapt to those parameters as well. * * @return Form */ public function VersionsForm() { $id = $this->currentPageID(); $page = $this->getRecord($id); $versionsHtml = ''; $action = $this->request->param('Action'); $versionID = $this->request->param('VersionID'); $otherVersionID = $this->request->param('OtherVersionID'); $showUnpublishedChecked = 0; $compareModeChecked = ($action == "compare"); if($page) { $versions = $page->allVersions(); $versionID = (!$versionID) ? $page->Version : $versionID; if($versions) { foreach($versions as $k => $version) { $active = false; if($version->Version == $versionID || $version->Version == $otherVersionID) { $active = true; if(!$version->WasPublished) $showUnpublishedChecked = 1; } $version->Active = ($active); } } $vd = new ViewableData(); $versionsHtml = $vd->customise(array( 'Versions' => $versions ))->renderWith('CMSPageHistoryController_versions'); } $fields = new FieldList( new CheckboxField( 'ShowUnpublished', _t('CMSPageHistoryController.SHOWUNPUBLISHED','Show unpublished versions'), $showUnpublishedChecked ), new CheckboxField( 'CompareMode', _t('CMSPageHistoryController.COMPAREMODE', 'Compare mode (select two)'), $compareModeChecked ), new LiteralField('VersionsHtml', $versionsHtml), $hiddenID = new HiddenField('ID', false, "") ); $actions = new FieldList( new FormAction( 'doCompare', _t('CMSPageHistoryController.COMPAREVERSIONS','Compare Versions') ), new FormAction( 'doShowVersion', _t('CMSPageHistoryController.SHOWVERSION','Show Version') ) ); // Use <button> to allow full jQuery UI styling foreach($actions->dataFields() as $action) $action->setUseButtonTag(true); $form = new Form( $this, 'VersionsForm', $fields, $actions ); $form->loadDataFrom($this->request->requestVars()); $hiddenID->setValue($id); $form->unsetValidator(); $form ->addExtraClass('cms-versions-form') // placeholder, necessary for $.metadata() to work ->setAttribute('data-link-tmpl-compare', Controller::join_links($this->Link('compare'), '%s', '%s', '%s')) ->setAttribute('data-link-tmpl-show', Controller::join_links($this->Link('show'), '%s', '%s')); return $form; } /** * Process the {@link VersionsForm} compare function between two pages. * * @param array * @param Form * * @return html */ public function doCompare($data, $form) { $versions = $data['Versions']; if(count($versions) < 2) return null; $id = $this->currentPageID(); $version1 = array_shift($versions); $version2 = array_shift($versions); $form = $this->CompareVersionsForm($version1, $version2); // javascript solution, render into template if($this->request->isAjax()) { return $this->customise(array( "EditForm" => $form ))->renderWith(array( $this->class . '_EditForm', 'LeftAndMain_Content' )); } // non javascript, redirect the user to the page $this->redirect(Controller::join_links( $this->Link('compare'), $version1, $version2 )); } /** * Process the {@link VersionsForm} show version function. Only requires * one page to be selected. * * @param array * @param Form * * @return html */ public function doShowVersion($data, $form) { $versionID = null; if(isset($data['Versions']) && is_array($data['Versions'])) { $versionID = array_shift($data['Versions']); } if(!$versionID) return; if($request->isAjax()) { return $this->customise(array( "EditForm" => $this->ShowVersionForm($versionID) ))->renderWith(array( $this->class . '_EditForm', 'LeftAndMain_Content' )); } // non javascript, redirect the user to the page $this->redirect(Controller::join_links( $this->Link('version'), $versionID )); } /** * @return Form */ public function ShowVersionForm($versionID = null) { if(!$versionID) return null; $id = $this->currentPageID(); $form = $this->getEditForm($id, null, $versionID); return $form; } /** * @return Form */ public function CompareVersionsForm($versionID, $otherVersionID) { if($versionID > $otherVersionID) { $toVersion = $versionID; $fromVersion = $otherVersionID; } else { $toVersion = $otherVersionID; $fromVersion = $versionID; } if(!$toVersion || !$toVersion) return false; $id = $this->currentPageID(); $page = DataObject::get_by_id("SiteTree", $id); if($page && !$page->canView()) { return Security::permissionFailure($this); } $record = $page->compareVersions($fromVersion, $toVersion); $fromVersionRecord = Versioned::get_version('SiteTree', $id, $fromVersion); $toVersionRecord = Versioned::get_version('SiteTree', $id, $toVersion); if(!$fromVersionRecord) { user_error("Can't find version $fromVersion of page $id", E_USER_ERROR); } if(!$toVersionRecord) { user_error("Can't find version $toVersion of page $id", E_USER_ERROR); } if($record) { $form = $this->getEditForm($id, null, null, true); $form->setActions(new FieldList()); $form->addExtraClass('compare'); // Comparison views shouldn't be editable. // Its important to convert fields *before* loading data, // as the comparison output is HTML and not valid values for the various field types $readonlyFields = $form->Fields()->makeReadonly(); $form->setFields($readonlyFields); $form->loadDataFrom($record); $form->loadDataFrom(array( "ID" => $id, "Version" => $fromVersion, )); foreach($form->Fields()->dataFields() as $field) { $field->dontEscape = true; } return $form; } } }