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

Introduction

Here is the source code for org.xwiki.edit.internal.EditorWikiComponentBuilder.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 java.util.ArrayList;
import java.util.Collections;
import java.util.List;

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

import org.apache.commons.lang3.exception.ExceptionUtils;
import org.slf4j.Logger;
import org.xwiki.component.annotation.Component;
import org.xwiki.component.wiki.WikiComponent;
import org.xwiki.component.wiki.WikiComponentBuilder;
import org.xwiki.component.wiki.WikiComponentException;
import org.xwiki.edit.Editor;
import org.xwiki.model.reference.DocumentReference;
import org.xwiki.model.reference.DocumentReferenceResolver;
import org.xwiki.query.Query;
import org.xwiki.query.QueryException;
import org.xwiki.query.QueryManager;

/**
 * Builds {@link Editor} components defined in wiki pages using {@code XWiki.EditorClass} objects.
 * 
 * @version $Id: 4c1544df1a82a58df5a45e6058724b0405f8610f $
 * @since 8.2RC1
 */
@Component
@Named("editor")
@Singleton
public class EditorWikiComponentBuilder implements WikiComponentBuilder {
    @Inject
    private Logger logger;

    @Inject
    private QueryManager queryManager;

    @Inject
    @Named("current")
    private DocumentReferenceResolver<String> currentDocumentReferenceResolver;

    @Inject
    @SuppressWarnings("rawtypes")
    private Provider<EditorWikiComponent> editorWikiComponentProvider;

    @Override
    public List<WikiComponent> buildComponents(DocumentReference reference) throws WikiComponentException {
        EditorWikiComponent<?> editorWikiComponent = this.editorWikiComponentProvider.get();
        editorWikiComponent.initialize(reference);
        return Collections.singletonList(editorWikiComponent);
    }

    @Override
    public List<DocumentReference> getDocumentReferences() {
        List<DocumentReference> editorReferences = new ArrayList<>();
        try {
            // NOTE: We use HQL and not XWQL here because the conversion from XWQL to HQL requires the class definition
            // (XWiki.EditorClass) to be present in order to determine which column to join (StringProperty here), and
            // the class definition might not be available yet (it is initialized by EditorClassDocumentInitializer). We
            // noticed this problem at build time when the XWiki package is created for functional tests.
            Query query = this.queryManager.createQuery(", BaseObject as editorObject, StringProperty as roleHint "
                    + "where doc.fullName = editorObject.name and editorObject.className = 'XWiki.EditorClass' and "
                    + "editorObject.id = roleHint.id.id and roleHint.id.name='roleHint' and "
                    + "(roleHint.value <> '' or (roleHint.value is not null and '' is null))", Query.HQL);
            for (Object result : query.execute()) {
                editorReferences.add(this.currentDocumentReferenceResolver.resolve(result.toString()));
            }
        } catch (QueryException e) {
            this.logger.warn("Failed to query the editors defined in wiki pages. Root cause: [{}]",
                    ExceptionUtils.getRootCauseMessage(e));
        }
        return editorReferences;
    }
}