TokenBasedUploadCommand.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.web.plugin.cmd;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.xwiki.context.Execution;
import org.xwiki.model.reference.DocumentReference;

import com.celements.filebase.IAttachmentServiceRole;
import com.celements.web.service.IWebUtilsService;
import com.celements.web.token.TokenLDAPAuthServiceImpl;
import com.xpn.xwiki.XWikiContext;
import com.xpn.xwiki.XWikiException;
import com.xpn.xwiki.api.Document;
import com.xpn.xwiki.doc.XWikiAttachment;
import com.xpn.xwiki.doc.XWikiDocument;
import com.xpn.xwiki.web.Utils;

public class TokenBasedUploadCommand {

  private static final Log LOGGER = LogFactory.getLog(TokenBasedUploadCommand.class);

  private TokenLDAPAuthServiceImpl tokenAuthImpl = new TokenLDAPAuthServiceImpl();

  IWebUtilsService webUtilsService;

  private IAttachmentServiceRole getAttService() {
    return Utils.getComponent(IAttachmentServiceRole.class);
  }

  private XWikiContext getContext() {
    return (XWikiContext) getExecution().getContext().getProperty("xwikicontext");
  }

  private Execution getExecution() {
    return Utils.getComponent(Execution.class);
  }

  IWebUtilsService getWebUtilsService() {
    if (webUtilsService != null) {
      return webUtilsService;
    }
    return Utils.getComponent(IWebUtilsService.class);
  }

  @Deprecated
  public int tokenBasedUpload(Document attachToDoc, String fieldName, String userToken,
      XWikiContext context) throws XWikiException {
    String username = tokenAuthImpl.getUsernameForToken(userToken, context);
    if ((username != null) && !username.equals("")) {
      LOGGER.info("tokenBasedUpload: user " + username + " identified by userToken.");
      context.setUser(username);
      return attachToDoc.addAttachments(fieldName);
    } else {
      LOGGER.warn("tokenBasedUpload: username could not be identified by token");
    }
    return 0;
  }

  /**
   * @deprecated since 2.59.1 instead use tokenBasedUploadDocRef
   */
  @Deprecated
  public int tokenBasedUpload(String attachToDocFN, String fieldNamePrefix, String userToken,
      Boolean createIfNotExists, XWikiContext context) throws XWikiException {
    return tokenBasedUploadDocRef(webUtilsService.resolveDocumentReference(attachToDocFN),
        fieldNamePrefix, userToken, createIfNotExists);
  }

  public int tokenBasedUploadDocRef(DocumentReference attachToDocRef, String fieldNamePrefix,
      String userToken, Boolean createIfNotExists) throws XWikiException {
    String username = tokenAuthImpl.getUsernameForToken(userToken, getContext());
    if ((username != null) && !username.equals("")) {
      LOGGER.info("tokenBasedUpload: user " + username + " identified by userToken.");
      getContext().setUser(username);
      // FIXME use IModelAccessFacade to access the document to ensure that new documents
      // FIXME get created correctly. (JIRA: CELDEV-132)
      XWikiDocument doc = getContext().getWiki().getDocument(attachToDocRef, getContext());
      if (createIfNotExists || getContext().getWiki().exists(attachToDocRef, getContext())) {
        LOGGER.info("tokenBasedUpload: add attachment [" + fieldNamePrefix + "] to doc ["
            + attachToDocRef + "].");
        if (LOGGER.isTraceEnabled()) {
          for (XWikiAttachment origAttach : doc.getAttachmentList()) {
            LOGGER.trace("tokenBasedUpload - origialDoc before addAttachments: "
                + origAttach.getFilename() + ", " + origAttach.getVersion());
          }
        }
        return getAttService().uploadMultipleAttachments(doc, fieldNamePrefix);
      } else {
        LOGGER.warn("tokenBasedUpload: document " + attachToDocRef + " does not exist.");
      }
    } else {
      LOGGER.warn("tokenBasedUpload: username could not be identified by token");
    }
    return 0;
  }

}