net.sf.mpxj.mpp.CustomFieldReader14 Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of mpxj Show documentation

Library that provides facilities to allow project information to be manipulated in Java and .Net. Supports a range of data formats: Microsoft Project Exchange (MPX), Microsoft Project (MPP,MPT), Microsoft Project Data Interchange (MSPDI XML), Microsoft Project Database (MPD), Planner (XML), Primavera (PM XML, XER, and database), Asta Powerproject (PP, MDB), Asta Easyplan (PP), Phoenix Project Manager (PPX), FastTrack Schedule (FTS), and the Standard Data Exchange Format (SDEF).

There is a newer version: 13.6.0

Show newest version

/*
 * file:       CustomFieldReader14.java
 * author:     Jon Iles
 * copyright:  (c) Packwood Software 2022
 * date:       2022-08-05
 */

/*
 * This library 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 library 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 library; if not, write to the Free Software Foundation, Inc.,
 * 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
 */

package net.sf.mpxj.mpp;

import java.util.HashMap;
import java.util.Map;

import net.sf.mpxj.CustomFieldContainer;
import net.sf.mpxj.DataType;
import net.sf.mpxj.FieldType;
import net.sf.mpxj.ProjectFile;
import net.sf.mpxj.UserDefinedField;
import net.sf.mpxj.common.FieldTypeHelper;

/**
 * Reads field aliases from an MPP file.
 */
class CustomFieldReader14
{
   /**
    * Constructor.
    *
    * @param file project file
    * @param data raw MP data
    */
   public CustomFieldReader14(ProjectFile file, byte[] data)
   {
      m_file = file;
      m_fields = file.getCustomFields();
      m_data = data;
   }

   /**
    * Process field aliases.
    */
   public void process()
   {
      if (m_data == null)
      {
         return;
      }

      Map aliasMap = new HashMap<>();
      int index = 0;
      int offset = 0;
      // First the length (repeated twice)
      int aliasBlockSize = MPPUtility.getInt(m_data, offset);
      offset += 8;
      // Then the number of custom columns
      int numberOfAliases = MPPUtility.getInt(m_data, offset);
      offset += 4;

      // Then the aliases themselves
      while (index < numberOfAliases && offset < aliasBlockSize)
      {
         // Get the Field ID
         int fieldID = MPPUtility.getInt(m_data, offset);
         offset += 4;

         // Get the alias offset (offset + 4 for some reason).
         int aliasOffset = MPPUtility.getInt(m_data, offset) + 4;
         offset += 4;
         // Read the alias itself
         if (aliasOffset < m_data.length)
         {
            String alias = MPPUtility.getUnicodeString(m_data, aliasOffset);
            if (!alias.isEmpty())
            {
               aliasMap.put(Integer.valueOf(fieldID), alias);
            }
         }
         index++;
      }

      // Skip past the alias block
      offset = 4 + aliasBlockSize;

      // Unknown block 1: size, size count
      if (offset + 4 > m_data.length)
      {
         return;
      }
      int unknownBlock1Size = MPPUtility.getInt(m_data, offset);
      offset += 4;
      offset += unknownBlock1Size;
      if (offset > m_data.length)
      {
         return;
      }

      // Unknown block 2: size, size count
      if (offset + 4 > m_data.length)
      {
         return;
      }
      int unknownBlock2Size = MPPUtility.getInt(m_data, offset);
      offset += 4;
      offset += unknownBlock2Size;
      if (offset > m_data.length)
      {
         return;
      }

      // Field definitions block
      if (offset + 8 > m_data.length)
      {
         return;
      }
      int numberOfDefinitions = MPPUtility.getInt(m_data, offset);
      offset += 4;

      //int definitionsBlockSize = MPPUtility.getInt(m_data, offset);
      offset += 4;

      // 88 byte blocks
      for (int definitionIndex = 0; definitionIndex < numberOfDefinitions; definitionIndex++)
      {
         // stop if we've run out of data
         if (offset + 88 > m_data.length)
         {
            break;
         }

         DataType customFieldDataType = EnterpriseCustomFieldDataType.getDataTypeFromID(MPPUtility.getShort(m_data, offset + 12));
         FieldTypeHelper.getInstance(m_file, MPPUtility.getInt(m_data, offset), customFieldDataType);

         offset += 88;
      }

      aliasMap.forEach((k,v) -> m_fields.getOrCreate(FieldTypeHelper.getInstance(m_file, k.intValue())).setAlias(v));
   }

   private final ProjectFile m_file;
   private final CustomFieldContainer m_fields;
   private final byte[] m_data;
}