org.xwiki.edit.internal.XDOMEditorConfiguration.java Source code

Introduction

Here is the source code for org.xwiki.edit.internal.XDOMEditorConfiguration.java

Source

/*
 * 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 org.xwiki.edit.internal;

import javax.inject.Inject;
import javax.inject.Named;
import javax.inject.Singleton;

import org.apache.commons.lang3.StringUtils;
import org.xwiki.component.annotation.Component;
import org.xwiki.configuration.ConfigurationSource;
import org.xwiki.edit.Editor;
import org.xwiki.edit.EditorConfiguration;
import org.xwiki.rendering.block.XDOM;

/**
 * Custom configuration for {@link XDOM} {@link Editor}s, which serves two roles:
 * <ul>
 * <li>preserves backward compatibility (because it looks for configuration properties that existed before the edit
 * module was written)</li>
 * <li>provides the default editor when there's no one configured</li>
 * </ul>
 * .
 * 
 * @version $Id: e29072dbe23d4673dc4c971b769a60c88b17b8cd $
 * @since 8.2RC1
 */
@Component
@Singleton
public class XDOMEditorConfiguration implements EditorConfiguration<XDOM> {
    @Inject
    @Named("user")
    private ConfigurationSource userConfig;

    @Inject
    @Named("documents")
    private ConfigurationSource documentsConfig;

    @Inject
    @Named("xwikicfg")
    private ConfigurationSource xwikiConfig;

    @Override
    public String getDefaultEditor() {
        String propertyName = "editor";
        String defaultEditor = this.userConfig.getProperty(propertyName, String.class);
        if (StringUtils.isEmpty(defaultEditor)) {
            defaultEditor = this.documentsConfig.getProperty(propertyName, String.class);
            if (StringUtils.isEmpty(defaultEditor)) {
                defaultEditor = this.xwikiConfig.getProperty("xwiki.editor", TextXDOMEditor.ROLE_HINT);
            }
        }
        // We need to keep the value case insensitive for backwards compatibility.
        return StringUtils.lowerCase(defaultEditor);
    }

    @Override
    public String getDefaultEditor(String category) {
        if (StringUtils.isEmpty(category)) {
            return getDefaultEditor();
        } else if (TextXDOMEditor.ROLE_HINT.equals(category)) {
            return TextXDOMEditor.ROLE_HINT;
        } else {
            return null;
        }
    }
}