Ticket #4199: CMSMain.patch

CMSMain.php

@@ -3 +3 @@
  * The main "content" area of the CMS.
  * This class creates a 2-frame layout - left-tree and right-form - to sit beneath the main
  * admin menu.
- * 
+ *
  * @package cms
  * @subpackage content
  * @todo Create some base classes to contain the generic functionality that will be replicated.
  */
 class CMSMain extends LeftAndMain implements CurrentPageIdentifier, PermissionProvider {
-        
+
         static $url_segment = '';
-        
+
         static $url_rule = '/$Action/$ID/$OtherID';
-        
+
         // Maintain a lower priority than other administration sections
         // so that Director does not think they are actions of CMSMain
         static $url_priority = 40;
-        
+
         static $menu_title = 'Site Content';
-        
+
         static $menu_priority = 10;
-        
+
         static $tree_class = "SiteTree";
-        
+
         static $subitem_class = "Member";
-        
+
         static $allowed_actions = array(
                 'addmember',
                 'addpage',
@@ -57 +57 @@
                 'getfilteredsubtree',
                 'batchactions'
         );
-        
+
         /**
          * SiteTree Columns that can be filtered using the the Site Tree Search button
          */
         static $site_tree_filter_options = array(
                 'Title' => array('CMSMain.TITLE', 'Title'),
                 'MenuTitle' => array('CMSMain.MENUTITLE', 'Navigation Label'),
-                'ClassName' => array('CMSMain.PAGETYPE', 'Page Type'), 
+                'ClassName' => array('CMSMain.PAGETYPE', 'Page Type'),
                 'Status' => array('CMSMain.STATUS', 'Status'),
                 'MetaDescription' => array('CMSMain.METADESC', 'Description'),
                 'MetaKeywords' => array('CMSMain.METAKEYWORDS', 'Keywords')
         );
-        
+
         static function T_SiteTreeFilterOptions(){
                 return array(
                         'Title' => _t('CMSMain.TITLEOPT', 'Title', 0, 'The dropdown title in CMSMain left SiteTreeFilterOptions'),
                         'MenuTitle' => _t('CMSMain.MENUTITLEOPT', 'Navigation Label', 0, 'The dropdown title in CMSMain left SiteTreeFilterOptions'),
-                        'Status' => _t('CMSMain.STATUSOPT', 'Status',  0, "The dropdown title in CMSMain left SiteTreeFilterOptions"), 
-                        'MetaDescription' => _t('CMSMain.METADESCOPT', 'Description', 0, "The dropdown title in CMSMain left SiteTreeFilterOptions"), 
+                        'Status' => _t('CMSMain.STATUSOPT', 'Status',  0, "The dropdown title in CMSMain left SiteTreeFilterOptions"),
+                        'MetaDescription' => _t('CMSMain.METADESCOPT', 'Description', 0, "The dropdown title in CMSMain left SiteTreeFilterOptions"),
                         'MetaKeywords' => _t('CMSMain.METAKEYWORDSOPT', 'Keywords', 0, "The dropdown title in CMSMain left SiteTreeFilterOptions")
                 );
         }
-        
+
         public function init() {
                 parent::init();
-                
+
                 // Locale" attribute is either explicitly added by LeftAndMain Javascript logic,
                 // or implied on a translated record (see {@link Translatable->updateCMSFields()}).
                 if(Translatable::is_enabled()) {
@@ -92 +92 @@
                                 $this->Locale = $this->getRequest()->requestVar("Locale");
                         } elseif($this->getRequest()->requestVar("locale")) {
                                 $this->Locale = $this->getRequest()->requestVar("locale");
+                        } elseif (Session::get("{$this->class}.Locale")) {
+                          $this->Locale = Session::get("{$this->class}.Locale");
                         } else {
                                 $this->Locale = Translatable::default_locale();
                         }
                         Translatable::set_current_locale($this->Locale);
+                        Session::set("{$this->class}.Locale", $this->Locale);
                 }
-                
+
                 // collect languages for TinyMCE spellchecker plugin
                 if(Translatable::is_enabled()) {
                         $spellcheckLangs = Translatable::get_existing_content_languages();
@@ -110 +113 @@
 
                 // Set custom options for TinyMCE specific to CMSMain
                 HtmlEditorConfig::get('cms')->setOption('spellchecker_languages', '+' . implode(',', $spellcheckSpec));
-                                
+
                 Requirements::javascript(CMS_DIR . '/javascript/CMSMain.js');
                 Requirements::javascript(CMS_DIR . '/javascript/CMSMain_left.js');
                 Requirements::javascript(CMS_DIR . '/javascript/CMSMain_right.js');
         }
-        
+
         /**
          * If this is set to true, the "switchView" context in the
          * template is shown, with links to the staging and publish site.
@@ -134 +137 @@
 
         /**
          * Override {@link LeftAndMain} Link to allow blank URL segment for CMSMain.
-         * 
+         *
          * @return string
          */
         public function Link($action = null) {
@@ -174 +177 @@
 
                 return $tree;
         }
-        
+
         public function getfilteredsubtree() {
                 // Get the tree
                 $tree = $this->getSiteTreeFor($this->stat('tree_class'), $_REQUEST['ID'], null, array(new CMSMainMarkingFilter(), 'mark'));
@@ -182 +185 @@
                 // Trim off the outer tag
                 $tree = ereg_replace('^[ \t\r\n]*<ul[^>]*>','', $tree);
                 $tree = ereg_replace('</ul[^>]*>[ \t\r\n]*$','', $tree);
-                
+
                 return $tree;
         }
-        
+
         /**
          * Returns the SiteTree columns that can be filtered using the the Site Tree Search button as a DataObjectSet
          */
@@ -208 +211 @@
                         $types = SiteTree::page_type_classes(); array_unshift($types, 'All');
                         $optionsetField = new DropdownField('ClassName', 'ClassName', array_combine($types, $types), 'Any');
                         return $optionsetField->Field();
-                }       
+                }
 
         public function generateDataTreeHints() {
                 $classes = ClassInfo::subclassesFor( $this->stat('tree_class') );
@@ -324 +327 @@
                         if($instance->stat('need_permission') && !$this->can(singleton($class)->stat('need_permission'))) continue;
 
                         $addAction = $instance->i18n_singular_name();
-                        
+
                         // if we're in translation mode, the link between the translated pagetype
                         // title and the actual classname might not be obvious, so we add it in parantheses
                         // Example: class "RedirectorPage" has the title "Weiterleitung" in German,
@@ -338 +341 @@
                                 'AddAction' => $addAction,
                         )));
                 }
-                
+
                 $result->sort('AddAction');
-                
+
                 return $result;
         }
 
@@ -363 +366 @@
                                 $record = DataObject::get_one( $treeClass, "`$treeClass`.ID = $id");
                                 if($record) Versioned::reading_stage(null);
                         }
-                        
+
                         // Then, try getting a deleted record
                         if(!$record) {
                                 $record = Versioned::get_latest_version($treeClass, $id);
@@ -399 +402 @@
                         $fields->push(new HiddenField('Sort','', $record->Sort ));
 
                         $idField->setValue($id);
-                        
+
                         if($record->ID && is_numeric( $record->ID ) ) {
                                 $liveRecord = Versioned::get_one_by_stage('SiteTree', 'Live', "`SiteTree`.ID = $record->ID");
                                 if($liveRecord) $liveURLField->setValue($liveRecord->AbsoluteLink());
                         }
-                        
+
                         if(!$record->IsDeletedFromStage) {
                                 $stageURLField->setValue($record->AbsoluteLink());
                         }
-                        
+
                         // getAllCMSActions can be used to completely redefine the action list
                         if($record->hasMethod('getAllCMSActions')) {
                                 $actions = $record->getAllCMSActions();
@@ -458 +461 @@
 
                 if(is_numeric($parent)) $parentObj = DataObject::get_by_id("SiteTree", $parent);
                 if(!$parentObj || !$parentObj->ID) $parent = 0;
-                
+
                 if($parentObj && !$parentObj->canAddChildren()) return Security::permissionFailure($this);
                 if(!singleton($className)->canCreate()) return Security::permissionFailure($this);
 
@@ -474 +477 @@
          */
         public function getNewItem($id, $setID = true) {
                 list($dummy, $className, $parentID, $suffix) = array_pad(explode('-',$id),4,null);
-                
+
                 $newItem = new $className();
 
             if( !$suffix ) {
@@ -507 +510 @@
 
                 # Some modules like subsites add extra fields that need to be set when the new item is created
                 $this->extend('augmentNewSiteTreeItem', $newItem);
-                
+
                 return $newItem;
         }
 
         /**
          * Delete the page from live. This means a page in draft mode might still exist.
-         * 
+         *
          * @see delete()
          */
         public function deletefromlive($urlParams, $form) {
@@ -521 +524 @@
                 Versioned::reading_stage('Live');
                 $record = DataObject::get_by_id("SiteTree", $id);
                 if($record && !$record->canDelete()) return Security::permissionFailure($this);
-                
+
                 $descRemoved = '';
                 $descendantsRemoved = 0;
-                
+
                 // before deleting the records, get the descendants of this tree
                 if($record) {
                         $descendantIDs = $record->getDescendantIDList('SiteTree');
@@ -561 +564 @@
          */
         public function performPublish($record) {
                 if($record && !$record->canPublish()) return Security::permissionFailure($this);
-                
+
                 $record->doPublish();
         }
 
@@ -569 +572 @@
          * Reverts a page by publishing it to live.
          * Use {@link restorepage()} if you want to restore a page
          * which was deleted from draft without publishing.
-         * 
+         *
          * @uses SiteTree->doRevertToLive()
          */
         public function revert($urlParams, $form) {
@@ -578 +581 @@
                 // a user can restore a page without publication rights, as it just adds a new draft state
                 // (this action should just be available when page has been "deleted from draft")
                 if($record && !$record->canEdit()) return Security::permissionFailure($this);
-                
+
                 $record->doRevertToLive();
 
                 $title = Convert::raw2js($record->Title);
@@ -588 +591 @@
 
                 return FormResponse::respond();
         }
-        
+
         /**
          * Delete the current page from draft stage.
          * @see deletefromlive()
@@ -597 +600 @@
                 $id = $_REQUEST['ID'];
                 $record = DataObject::get_one("SiteTree", "SiteTree.ID = $id");
                 if($record && !$record->canDelete()) return Security::permissionFailure();
-                
+
                 // save ID and delete record
                 $recordID = $record->ID;
                 $record->delete();
-                
+
                 if(Director::is_ajax()) {
                         // need a valid ID value even if the record doesn't have one in the database
                         // (its still present in the live tables)
@@ -615 +618 @@
                                 FormResponse::add($this->deleteTreeNodeJS($record));
                                 FormResponse::status_message(sprintf(_t('CMSMain.REMOVEDPAGEFROMDRAFT',"Removed '%s' from the draft site"),$record->Title), 'good');
                                 return FormResponse::respond();
-                        }                       
+                        }
                 } else {
                         Director::redirectBack();
                 }
@@ -675 +678 @@
 
                 $page = DataObject::get_by_id("SiteTree", $SQL_id);
                 if($page && !$page->canPublish()) return Security::permissionFailure($this);
-                
+
                 $page->doUnpublish();
-                
+
                 return $this->tellBrowserAboutPublicationChange($page, sprintf(_t('CMSMain.REMOVEDPAGE',"Removed '%s' from the published site"),$page->Title));
         }
-        
+
         /**
          * Return a few pieces of information about a change to a page
          *  - Send the new status message
@@ -697 +700 @@
 
                 FormResponse::add($this->getActionUpdateJS($page));
                 FormResponse::update_status($page->Status);
-                
+
                 if($JS_stageURL || $JS_liveURL) {
                         FormResponse::add("\$('sitetree').setNodeTitle($page->ID, '$JS_title');");
                 } else {
@@ -705 +708 @@
                         FormResponse::add("if(node && node.parentTreeNode) node.parentTreeNode.removeTreeNode(node);");
                         FormResponse::add("$('Form_EditForm').reloadIfSetTo($page->ID);");
                 }
-                
+
                 FormResponse::status_message($statusMessage, 'good');
                 FormResponse::add("$('Form_EditForm').elements.StageURLSegment.value = '$JS_stageURL';");
                 FormResponse::add("$('Form_EditForm').elements.LiveURLSegment.value = '$JS_liveURL';");
@@ -717 +720 @@
         function performRollback($id, $version) {
                 $record = DataObject::get_by_id($this->stat('tree_class'), $id);
                 if($record && !$record->canPublish()) return Security::permissionFailure($this);
-                
+
                 $record->doRollbackTo($version);
                 return $record;
         }
@@ -730 +733 @@
 
                 if($record) {
                         if($record && !$record->canView()) return Security::permissionFailure($this);
-                        
+
                         $fields = $record->getCMSFields($this);
                         $fields->removeByName("Status");
 
@@ -738 +741 @@
                         $fields->push(new HiddenField("Version"));
                         $fields->insertBefore(
                                 new LiteralField(
-                                        'YouAreViewingHeader', 
+                                        'YouAreViewingHeader',
                                         '<p class="message notice">' .
                                         sprintf(
                                                 _t(
@@ -747 +750 @@
                                                         PR_MEDIUM,
                                                         'Version number is a linked string, created is a relative time (e.g. 2 days ago), by a specific author'
                                                 ),
-                                                "<a href=\"admin/getversion/$record->ID/$version\" title=\"" . $versionAuthor->Title . "\">$version</a>", 
+                                                "<a href=\"admin/getversion/$record->ID/$version\" title=\"" . $versionAuthor->Title . "\">$version</a>",
                                                 $record->obj('LastEdited')->Ago(),
                                                 $versionAuthor->Title
                                         ) .
@@ -764 +767 @@
 
                         // encode the message to appear in the body of the email
                         $archiveURL = Director::absoluteBaseURL() . $record->URLSegment . '?archiveDate=' . $record->obj('LastEdited')->URLDatetime();
-                        
+
                         // Ensure that source file comments are disabled
                         SSViewer::set_source_file_comments(false);
-                        
+
                         $archiveEmailMessage = urlencode( $this->customise( array( 'ArchiveDate' => $record->obj('LastEdited'), 'ArchiveURL' => $archiveURL ) )->renderWith( 'ViewArchivedEmail' ) );
                         $archiveEmailMessage = preg_replace( '/\+/', '%20', $archiveEmailMessage );
 
@@ -781 +784 @@
                                 "ID" => $id,
                                 "Version" => $version,
                         ));
-                        
+
                         // historical version shouldn't be editable
                         $readonlyFields = $form->Fields()->makeReadonly();
                         $form->setFields($readonlyFields);
@@ -791 +794 @@
                         ));
 
                         SSViewer::setOption('rewriteHashlinks', false);
-                        
+
                         if(Director::is_ajax()) {
                                 $result = $templateData->renderWith($this->class . '_right');
                                 $parts = split('</?form[^>]*>', $result);
@@ -799 +802 @@
                         } else {
                                 return $templateData->renderWith('LeftAndMain');
                         }
-                        
-                        
+
+
                 }
         }
 
@@ -819 +822 @@
 
                 $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($record) {
                         $fromDateNice = $fromVersionRecord->obj('LastEdited')->Ago();
                         $toDateNice = $toVersionRecord->obj('LastEdited')->Ago();
@@ -836 +839 @@
                         $fields->insertBefore(
                                 new LiteralField(
                                         'YouAreComparingHeader',
-                                        '<p class="message notice">' . 
+                                        '<p class="message notice">' .
                                         sprintf(
                                                 _t('CMSMain.COMPARINGV',"Comparing versions %s and %s"),
                                                 "<a href=\"admin/getversion/$id/$fromVersionRecord->Version\" title=\"$fromAuthor->Title\">$fromVersionRecord->Version</a> <small>($fromDateNice)</small>",
                                                 "<a href=\"admin/getversion/$id/$toVersionRecord->Version\" title=\"$toAuthor->Title\">$toVersionRecord->Version</a> <small>($toDateNice)</small>"
                                         ) .
                                         '</p>'
-                                ), 
+                                ),
                                 "Root"
                         );
 
@@ -855 +858 @@
                                 "ID" => $id,
                                 "Version" => $fromVersion,
                         ));
-                        
+
                         // comparison views shouldn't be editable
                         $readonlyFields = $form->Fields()->makeReadonly();
                         $form->setFields($readonlyFields);
-                        
+
                         foreach($form->Fields()->dataFields() as $field) {
                                 $field->dontEscape = true;
                         }
@@ -919 +922 @@
                         'DialogType' => 'alert'
                 ))->renderWith('Dialog');
         }
-        
+
         /**
          * Batch Actions Handler
          */
@@ -972 +975 @@
                 foreach( $this->PageTypes() as $arrayData ) {
                         $pageTypes[$arrayData->getField('ClassName')] = $arrayData->getField('AddAction');
                 }
-                
+
                 $fields = new FieldSet(
                         new HiddenField("ParentID"),
                         new HiddenField("Locale", 'Locale', Translatable::get_current_locale()),
                         new DropdownField("PageType", "", $pageTypes, 'Page')
                 );
-                
+
                 $actions = new FieldSet(
                         new FormAction("addpage", _t('CMSMain.GO',"Go"))
                 );
@@ -1019 +1022 @@
         function publishall() {
                 ini_set("memory_limit", -1);
                 ini_set('max_execution_time', 0);
-                
+
                 $response = "";
 
                 if(isset($this->requestParams['confirm'])) {
@@ -1029 +1032 @@
                         while(true) {
                                 foreach($pages as $page) {
                                         if($page && !$page->canPublish()) return Security::permissionFailure($this);
-                                        
+
                                         $page->doPublish();
                                         $page->destroy();
                                         unset($page);
@@ -1056 +1059 @@
                                         . _t('CMSMain.PUBALLCONFIRM',"Please publish every page in the site, copying content stage to live",PR_LOW,'Confirmation button') .'" />
                                 </form>';
                 }
-                
+
                 return $response;
         }
-        
+
         /**
          * Restore a completely deleted page from the SiteTree_versions table.
          */
@@ -1089 +1092 @@
                         if($page && !$page->canEdit()) return Security::permissionFailure($this);
 
                         $newPage = $page->duplicate();
-                        
+
                         // ParentID can be hard-set in the URL.  This is useful for pages with multiple parents
                         if($_GET['parentID'] && is_numeric($_GET['parentID'])) {
                                 $newPage->ParentID = $_GET['parentID'];
@@ -1114 +1117 @@
                         user_error("CMSMain::duplicate() Bad ID: '$id'", E_USER_WARNING);
                 }
         }
-        
 
-        
+
+
         /**
          * Create a new translation from an existing item, switch to this language and reload the tree.
          */
@@ -1125 +1128 @@
                 $originalLangID = (int)$_REQUEST['ID'];
 
                 $record = $this->getRecord($originalLangID);
-                
+
                 $this->Locale = $langCode;
                 Translatable::set_current_locale($langCode);
-                
+
                 // Create a new record in the database - this is different
                 // to the usual "create page" pattern of storing the record
                 // in-memory until a "save" is performed by the user, mainly
@@ -1137 +1140 @@
                 $translatedRecord = $record->createTranslation($langCode);
 
                 $url = sprintf(
-                        "%s/%d/?locale=%s", 
+                        "%s/%d/?locale=%s",
                         $this->Link('show'),
                         $translatedRecord->ID,
                         $langCode
@@ -1157 +1160 @@
                         $title = _t("{$class}.MENUTITLE", LeftAndMain::menu_title_for_class($class));
                 $perms["CMS_ACCESS_" . $class] = sprintf(
                                 _t(
-                                        'CMSMain.ACCESS', 
+                                        'CMSMain.ACCESS',
                                         "Access to '%s' (%s)",
                                         PR_MEDIUM,
                                         "Item in permission selection identifying the admin section, with title and classname. Example: Access to 'Files & Images' (AssetAdmin)"
-                                ), 
+                                ),
                                 $title,
                                 $class
                         );
                 }
                 $perms["CMS_ACCESS_LeftAndMain"] = _t(
-                        'CMSMain.ACCESSALLINTERFACES', 
+                        'CMSMain.ACCESSALLINTERFACES',
                         'Access to all CMS interfaces'
                 );
                 return $perms;
         }
-        
+
         /**
      * Returns all languages with languages already used appearing first.
      * Called by the SSViewer when rendering the template.
@@ -1181 +1184 @@
                 $member = Member::currentUser(); //check to see if the current user can switch langs or not
                 if(Permission::checkMember($member, 'VIEW_LANGS')) {
                         $dropdown = new LanguageDropdownField(
-                                'LangSelector', 
-                                'Language', 
-                                array(), 
-                                'SiteTree', 
+                                'LangSelector',
+                                'Language',
+                                array(),
+                                'SiteTree',
                                 'Locale-English'
                         );
                         $dropdown->setValue(Translatable::get_current_locale());
                         return $dropdown;
         }
-        
+
         //user doesn't have permission to switch langs so just show a string displaying current language
         return i18n::get_locale_name( Translatable::get_current_locale() );
     }
 
         /**
          * Determine if there are more than one languages in our site tree.
-         * 
+         *
          * @return boolean
          */
         function MultipleLanguages() {
@@ -1205 +1208 @@
 
                 return (count($langs) > 1);
         }
-        
+
         /**
          * @return boolean
          */
@@ -1215 +1218 @@
 }
 
 class CMSMainMarkingFilter {
-        
+
         function __construct() {
                 $this->ids = array();
                 $this->expanded = array();
-                
+
                 $where = array();
-                
+
                 // Match against URLSegment, Title, MenuTitle & Content
                 if (isset($_REQUEST['SiteTreeSearchTerm'])) {
                         $term = Convert::raw2sql($_REQUEST['SiteTreeSearchTerm']);
                         $where[] = "`URLSegment` LIKE '%$term%' OR `Title` LIKE '%$term%' OR `MenuTitle` LIKE '%$term%' OR `Content` LIKE '%$term%'";
                 }
-                
+
                 // Match against date
                 if (isset($_REQUEST['SiteTreeFilterDate'])) {
                         $date = $_REQUEST['SiteTreeFilterDate'];
                         $date = ((int)substr($date,6,4)) . '-' . ((int)substr($date,3,2)) . '-' . ((int)substr($date,0,2));
-                        $where[] = "`LastEdited` > '$date'"; 
+                        $where[] = "`LastEdited` > '$date'";
                 }
-                
+
                 // Match against exact ClassName
                 if (isset($_REQUEST['ClassName']) && $_REQUEST['ClassName'] != 'All') {
                         $klass = Convert::raw2sql($_REQUEST['ClassName']);
                         $where[] = "`ClassName` = '$klass'";
                 }
-                
-                // Partial string match against a variety of fields 
+
+                // Partial string match against a variety of fields
                 foreach (CMSMain::T_SiteTreeFilterOptions() as $key => $value) {
                         if (!empty($_REQUEST[$key])) {
                                 $match = Convert::raw2sql($_REQUEST[$key]);
                                 $where[] = "`$key` LIKE '%$match%'";
                         }
                 }
-                
+
                 $where = empty($where) ? '' : 'WHERE (' . implode(') AND (',$where) . ')';
-                
+
                 $parents = array();
-                
+
                 /* Do the actual search */
                 $res = DB::query('SELECT `ParentID`, `ID` FROM SiteTree '.$where);
                 if (!$res) return;
-                
+
                 /* And keep a record of parents we don't need to get parents of themselves, as well as IDs to mark */
                 foreach($res as $row) {
                         if ($row['ParentID']) $parents[$row['ParentID']] = true;
                         $this->ids[$row['ID']] = true;
                 }
-                
+
                 /* We need to recurse up the tree, finding ParentIDs for each ID until we run out of parents */
                 while (!empty($parents)) {
                         $res = DB::query('SELECT `ParentID`, `ID` FROM SiteTree WHERE `ID` in ('.implode(',',array_keys($parents)).')');
@@ -1275 +1278 @@
                         }
                 }
         }
-        
+
         function mark($node) {
                 $id = $node->ID;
                 if (array_key_exists($id, $this->expanded)) $node->markOpened();