SpacePreferencesConfigurationSource.java

/*
 * See the NOTICE file distributed with this work for additional
 * information regarding copyright ownership.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */
package com.celements.xwikiPatches;

import org.xwiki.component.annotation.Component;
import org.xwiki.model.EntityType;
import org.xwiki.model.reference.DocumentReference;

/**
 * In xwiki 2.7.2 the SpacePreferencesConfigurationSource by the broken
 * AbstractDocumentConfigurationSource on line 173 stating: classReference =
 * getDocumentReference(); And SpacePrefencesConfigurationSource.getClassReference ist
 * broken too on generating documentReference = new DocumentReference
 */
@Component("space")
public class SpacePreferencesConfigurationSource extends AbstractDocumentConfigurationSource {

  private static final String DOCUMENT_NAME = "WebPreferences";

  private static final String CLASS_SPACE_NAME = "XWiki";

  private static final String CLASS_PAGE_NAME = "XWikiPreferences";

  /**
   * {@inheritDoc}
   * 
   * @see org.xwiki.configuration.internal.AbstractDocumentConfigurationSource#getClassReference()
   */
  @Override
  protected DocumentReference getClassReference() {
    DocumentReference classReference = null;

    DocumentReference currentDocumentReference = getDocumentAccessBridge().getCurrentDocumentReference();
    if (currentDocumentReference != null) {
      // Add the current current wiki references to the XWiki Preferences class
      // reference to form
      // an absolute reference.
      classReference = new DocumentReference(currentDocumentReference.extractReference(
          EntityType.WIKI).getName(), CLASS_SPACE_NAME, CLASS_PAGE_NAME);
    }

    return classReference;
  }

  /**
   * {@inheritDoc}
   * 
   * @see AbstractDocumentConfigurationSource#getDocumentReference()
   */
  @Override
  protected DocumentReference getDocumentReference() {
    // Note: We would normally use a Reference Resolver here but since the Model
    // module uses the Configuration
    // module we cannot use one as otherwise we would create a cyclic build
    // dependency...

    DocumentReference documentReference = null;

    // Get the current document reference to extract the wiki and space names.
    DocumentReference currentDocumentReference = getDocumentAccessBridge().getCurrentDocumentReference();

    if (currentDocumentReference != null) {
      // Add the current spaces and current wiki references to the Web
      // Preferences document reference to form
      // an absolute reference.
      documentReference = new DocumentReference(DOCUMENT_NAME,
          currentDocumentReference.getLastSpaceReference());
    }

    return documentReference;
  }

}