diff --git a/pom.xml b/pom.xml index 8f9af2d..efe106d 100644 --- a/pom.xml +++ b/pom.xml @@ -5,7 +5,7 @@ com.odoojava odoo-java-api - 3.1.3 + 3.1.4 jar odoo-java-api diff --git a/src/main/java/com/odoojava/api/ObjectAdapter.java b/src/main/java/com/odoojava/api/ObjectAdapter.java index 447b921..2278240 100644 --- a/src/main/java/com/odoojava/api/ObjectAdapter.java +++ b/src/main/java/com/odoojava/api/ObjectAdapter.java @@ -46,1031 +46,1031 @@ */ public class ObjectAdapter { - private final String modelName; - private final OdooCommand command; - private final FieldCollection allFields; - private final Version serverVersion; - - // Object name cache so the adapter doesn't have to reread model names from - // the database for every new object. - // Bulk loads/reads can become very slow if every adapter requires a call - // back to the server - private static final List objectNameCache = new ArrayList<>(); - - // Object workflow signal cache so the adapter doesn't have to reread signal - // names from the database for every workflow call. - private static final List signalCache = new ArrayList<>(); - - // Cache used to store the name_get result of an model to cater for - // many2many relations in the import function - // It is cleared every time the import function is called for a specific - // object - private final Map> modelNameCache = new ConcurrentHashMap<>(); - - /** - * Default constructor - * - * @param session Session object that will be used to make the calls - * @param modelName Model name that this adapter will work for. - * @throws XmlRpcException - * @throws OdooApiException - */ - public ObjectAdapter(Session session, String modelName) throws XmlRpcException, OdooApiException { - this(new OdooCommand(session), modelName, session.getServerVersion()); - } - - ObjectAdapter(OdooCommand command, String modelName, Version serverVersion) - throws OdooApiException, XmlRpcException { - this.command = command; - this.modelName = modelName; - this.serverVersion = serverVersion; - - validateModelExists(); - - allFields = getFields(); - } - - /** - * Validates a model name against entries in ir.model The function is - * synchronized to make use of a global (static) list of model names to - * increase speed - * - * @param command Command object to use - * @throws OdooApiException If the model could not be validated - */ - @SuppressWarnings("unchecked") - synchronized void validateModelExists() throws OdooApiException, XmlRpcException { - // If you can't find the object name, reload the cache. Somebody may - // have added a new module after the cache was created - // Ticket #1 from sourceforge - - Object[] ids = null; - if (objectNameCache.indexOf(modelName) < 0) { - clearModelNameCache(); - //TODO: Improve this part by using appropriate filterhelper - Response response = command.searchObject("ir.model", new Object[]{}); - if (response.isSuccessful()) { - ids = response.getResponseObjectAsArray(); - Object[] result = command.readObject("ir.model", ids, new String[]{"model"}); - for (Object row : result) { - objectNameCache.add(((HashMap) row).get("model").toString()); - } - } - - } - - if (objectNameCache.indexOf(modelName) < 0) { - throw new OdooApiException("Could not find model with name '" + modelName + "'"); - } - } - - static void clearModelNameCache() { - objectNameCache.clear(); - } - - private void checkSignalExists(String signal) throws OdooApiException { - // If you can't find the signal, reload the cache. Somebody may have - // added a new module after the cache was created - String signalCombo = modelName + "#" + signal; - if (!signalCache.contains(signalCombo)) { - // Only one thread need to do the updating - synchronized (this.getClass()) { - // Cache may now contain the signal (updated by another thread - // while waiting at the synchronized gate). - if (!signalCache.contains(signalCombo)) { - refreshSignalCache(command); - } - } - } - - // If still not found, this is an error... - if (!signalCache.contains(signalCombo)) { - throw new OdooApiException( - "Could not find signal with name '" + signal + "' for object '" + modelName + "'"); - } - } - - @SuppressWarnings("unchecked") - private static void refreshSignalCache(OdooCommand command) throws OdooApiException { - signalCache.clear(); - try { - Response response = command.searchObject("workflow.transition", new Object[]{}); - Object[] ids = new Object[]{}; - if (response.isSuccessful()) { - ids = response.getResponseObjectAsArray(); - - Object[] result = command.readObject("workflow.transition", ids, new String[]{"signal", "wkf_id"}); - for (Object row : result) { - /* - * Get the parent workflow to work out get the object name - */ - //TODO: Check the latest syntax or workflow - int wkfId = Integer.parseInt(((Object[]) ((HashMap) row).get("wkf_id"))[0].toString()); - Object[] workflow = command.readObject("workflow", new Object[]{wkfId}, new String[]{"osv"}); - - String obj = ((HashMap) workflow[0]).get("osv").toString(); - String sig = ((HashMap) row).get("signal").toString(); - signalCache.add(obj + "#" + sig); - } - } - } catch (XmlRpcException e) { - throw new OdooApiException("Could not validate signal name: ", e); - } - } - - /** - * Prepares a ROW object to be used for setting values in import/write - * methods - * - * @param fields Fields that should be included in the row definition - * @return An empty row with the specified fields - * @throws XmlRpcException - * @throws OdooApiException - */ - public Row getNewRow(FieldCollection fields) throws OdooApiException { - return new Row(new HashMap(), fields); - } - - /** - * Prepares a ROW object to be used for setting values in import/write - * methods. This method calls to the server to get the fieldCollection. Use - * getNewRow(FieldCollection fields) if you can to reduce the number of - * calls to the server for a bulk load. - * - * @param fields Fields that should be included in the row definition - * @return An empty row with the specified fields - * @throws XmlRpcException - * @throws OdooApiException - */ - public Row getNewRow(String[] fields) throws XmlRpcException, OdooApiException { - return getNewRow(getFields(fields)); - } - - /** - * Reads objects from the Odoo server if you already have the ID's. If you - * don't, use searchAndRead with filters. - * - * @param ids List of ids to fetch objects for - * @param fields List of fields to fetch data for - * @return A collection of rows for an Odoo object - * @throws XmlRpcException - * @throws OdooApiException - */ - public RowCollection readObject(Object[] ids, String[] fields) throws XmlRpcException, OdooApiException { - - // Faster to do read existing fields that to do a server call again - FieldCollection fieldCol = new FieldCollection(); - for (String fieldName : fields) { - for (Field fld : allFields) { - if (fld.getName().equals(fieldName)) { - fieldCol.add(fld); - } - } - } - - Object[] results = command.readObject(modelName, ids, fields); - - /** - * ** - * 18/04/2012 - PvdM Maybe reconsider this piece of code for later. Does - * it matter if it isn't sorted by ID? - * - * // Odoo doesn't use the sorting you pass (specified in the search - * function to get a sorted list of IDs). // When they fix it, remove - * this section of code ArrayList idList = new ArrayList - * (); for (Object id : ids){ - * idList.add(Integer.parseInt(id.toString())); } Object[] sortedResults - * = new Object[ids.length]; for (Object result : results){ - * - * @SuppressWarnings("unchecked") int id = null null null null null null Integer.parseInt(((HashMap)result).get("id").toString()); - * sortedResults[idList.indexOf(id)] = result; } ** - */ - return new RowCollection(results, fieldCol); - } - - /** - * * - * Fetches field information for the current Odoo object this adapter is - * linked to - * - * @return FieldCollecton data for all fields of the object - * @throws XmlRpcException - */ - public FieldCollection getFields() throws XmlRpcException { - return this.getFields(new String[]{}); - } - - /** - * * - * Fetches field names for the current Odoo object this adapter is linked to - * - * @return Array of field names - * @throws XmlRpcException - */ - public String[] getFieldNames() throws XmlRpcException { - FieldCollection fields = getFields(new String[]{}); - String[] fieldNames = new String[fields.size()]; - for (int i = 0; i < fields.size(); i++) { - fieldNames[i] = fields.get(i).getName(); - } - return fieldNames; - } - - /** - * * - * Fetches field information for the current Odoo object this adapter is - * linked to - * - * @param filterFields Only return data for files in the filter list - * @return FieldCollecton data for selected fields of the object - * @throws XmlRpcException - */ - @SuppressWarnings("unchecked") - public FieldCollection getFields(String[] filterFields) throws XmlRpcException { - FieldCollection collection = new FieldCollection(); - - Map fields = command.getFields(modelName, filterFields); - - for (String fieldName : fields.keySet()) { - Map fieldDetails = (Map) fields.get(fieldName); - collection.add(new Field(fieldName, fieldDetails)); - } - - return collection; - } - - /** - * Helper function to validate filter parameters and returns a filter object - * suitable for the Odoo search function by fixing data types and converting - * values where appropriate. - * - * @param filters FilterCollection containing the specified filters - * @return A validated filter Object[] correctly formatted for use by the - * Odoo search function - * @throws OdooApiException - */ - public Object[] validateFilters(final FilterCollection filters) throws OdooApiException { - - if (filters == null) { - return new Object[0]; - } - - ArrayList processedFilters = new ArrayList<>(); - - for (int i = 0; i < filters.getFilters().length; i++) { - Object filter = filters.getFilters()[i]; - - if (filter == null) { - throw new IllegalArgumentException("null filter parameter is not allowed"); - } - - // Is a logical operator - if (filter instanceof String) { - processedFilters.add(filter); - continue; - } - - // Is a comparison filter - Object[] filterObjects = (Object[]) filter; - if (!(filter instanceof Object[]) || filterObjects.length != 3) { - throw new OdooApiException("Filters aren't in the correct format. Please read the Odoo help."); - } - - String fieldName = filterObjects[0].toString(); - String comparison = filterObjects[1].toString(); - Object value = filterObjects[2]; - - Field fld = findFieldByName(fieldName); - - // Can't search on calculated fields - if (fld != null && fld.getFunc_method()) { - throw new OdooApiException("Can not search on function field " + fieldName); - } - - // Fix the value type if required for the Odoo server - if (!"id".equals(fieldName) && fld == null) { - throw new OdooApiException("Unknow filter field " + fieldName); - } else if ("is null".equals(comparison)) { - comparison = "="; - value = false; - } else if ("is not null".equals(comparison)) { - comparison = "!="; - value = false; - } else if (fld != null && fld.getType() == FieldType.BOOLEAN && !(value instanceof Boolean)) { - value = convertToBoolean(value); - } else if (fld != null && fld.getType() == FieldType.FLOAT && !(value instanceof Double)) { - value = Double.parseDouble(value.toString()); - } else if (fld != null && fld.getType() == FieldType.DATE && value instanceof Date) { - value = new SimpleDateFormat("yyyy-MM-dd").format((Date) value); - } else if (fld != null && fld.getType() == FieldType.DATETIME && value instanceof Date) { - value = new SimpleDateFormat("yyyy-MM-dd HH:mm").format((Date) value); - } else if ("=".equals(comparison)) { - - // If a integer field is not an integer in a '=' comparison, - // parse it as an int - if (!(value instanceof Integer)) { - if ("id".equals(fieldName) - || (fld != null && fld.getType() == FieldType.INTEGER && !(value instanceof Integer)) - || (fld != null && fld.getType() == FieldType.MANY2ONE && !(value instanceof Integer))) { - value = Integer.parseInt(value.toString()); - } - } - } else if ("in".equalsIgnoreCase(comparison)) { - if (value instanceof String) { - // Split by , where the , isn't preceded by a \ - String[] entries = value.toString().split("(? idToName; - if (!modelNameCache.containsKey(fld.getRelation())) { - idToName = new HashMap<>(); - Object[] ids = new Object[]{}; - Response response = command.searchObject(fld.getRelation(), new Object[]{}); - if (response.isSuccessful()) { - ids = response.getResponseObjectAsArray(); - Object[] names = command.nameGet(fld.getRelation(), ids); - for (int j = 0; j < ids.length; j++) { - Object[] nameValue = (Object[]) names[j]; - idToName.put(nameValue[0].toString(), nameValue[1].toString()); - } - } - - modelNameCache.put(fld.getRelation(), idToName); - } else { - idToName = modelNameCache.get(fld.getRelation()); - } - - String newValue = ""; - // Comma separated list of IDs - if (value instanceof String) { - for (String singleID : value.toString().split(",")) { - if (idToName.containsKey(singleID)) { - newValue = newValue + "," + idToName.get(singleID); - } else { - throw new OdooApiException( - "Could not find " + fld.getRelation() + " with ID " + singleID); - } - } - } else { - // Object[] of values -- default - for (Object singleID : (Object[]) value) { - if (idToName.containsKey(singleID.toString())) { - newValue = newValue + "," + idToName.get(singleID.toString()); - } else { - throw new OdooApiException( - "Could not find " + fld.getRelation() + " with ID " + singleID.toString()); - } - } - } - outputRow[columnIndex] = newValue.substring(1); - - break; - - // The import procedure expects most types to be strings - default: - outputRow[columnIndex] = value.toString(); - break; - } - } - - return outputRow; - } - - private String[] getFieldListForImport(FieldCollection currentFields) { - return Stream - .concat(Stream.of(".id"), - currentFields.stream().map(ObjectAdapter::getFieldNameForImport)) - .toArray(String[]::new); - - } - - private static String getFieldNameForImport(Field field) { - // Return field name, adding ".id" if type is MANY2ONE - return field.getType() == FieldType.MANY2ONE ? field.getName() + ".id" - : field.getName(); - } - - /** - * Calls the import_data or load function on the server to bulk - * create/update records. - * - * The import_data function will be called on Odoo servers where the version - * number is < 7. The import_data function does not return IDs and therefore - * IDs will not be set on imported rows. - * - * The load function will be called for V7 and the IDs will be set on the - * imported rows. The load function was introduced in V7 and the import_data - * function deprecated. - * - * @param rows Rows to import. - * @return If the import was successful - * @throws XmlRpcException - * @throws OdooApiException - */ - public boolean importData(RowCollection rows) throws OdooApiException, XmlRpcException { - // Workaround: old and new rows can't be sent together - // together using the import_data or load function - if (this.serverVersion.getMajor() >= 7) { - RowCollection newRows = new RowCollection(); - RowCollection oldRows = new RowCollection(); - - for (int i = 0; i < rows.size(); i++) { - if (rows.get(i).getID() == 0) { - newRows.add(rows.get(i)); - } else { - oldRows.add(rows.get(i)); - } - } - - // If mixed rows, import old and new rows separately - if (!newRows.isEmpty() && !oldRows.isEmpty()) { - return this.importData(oldRows) && this.importData(newRows); - } - } - - modelNameCache.clear(); - - Object[][] importRows = new Object[rows.size()][]; - - for (int i = 0; i < rows.size(); i++) { - Row row = rows.get(i); - importRows[i] = fixImportData(row); - } - - if (this.serverVersion.getMajor() >= 7) { - // The load function was introduced in V7 and the import function - // deprecated - importDataV7(rows, importRows); - } else { - // Use older import rows function - importDataLegacy(rows, importRows); - } - - return true; - } - - private void importDataLegacy(RowCollection rows, Object[][] importRows) - throws XmlRpcException, OdooApiException { - - String[] targetFieldList = getFieldListForImport(rows.get(0).getFields()); - - Object[] result = command.importData(modelName, targetFieldList, importRows); - - // Should return the number of rows committed. If there was an - // error, it returns -1 - if ((Integer) result[0] != importRows.length) { - throw new OdooApiException(result[2].toString() + "\nRow :" + result[1].toString() + ""); - } - } - - @SuppressWarnings("unchecked") - private void importDataV7(RowCollection rows, Object[][] importRows) throws XmlRpcException, OdooApiException { - - String[] targetFieldList = getFieldListForImport(rows.get(0).getFields()); - - // Remove the .id field for new rows. - if (this.serverVersion.getMajor() >= 7 && !rows.isEmpty() && rows.get(0).getID() == 0) { - String[] newTargetFieldList = new String[targetFieldList.length - 1]; - for (int i = 1; i < targetFieldList.length; i++) { - newTargetFieldList[i - 1] = targetFieldList[i]; - } - targetFieldList = newTargetFieldList; - - Object[][] newImportRows = new Object[rows.size()][]; - for (int i = 0; i < importRows.length; i++) { - Object[] newRow = new Object[importRows[i].length - 1]; - for (int j = 1; j < importRows[i].length; j++) { - newRow[j - 1] = importRows[i][j]; - } - newImportRows[i] = newRow; - } - importRows = newImportRows; - } - - Map results = command.load(modelName, targetFieldList, importRows); - - if (results.get("ids") instanceof Boolean) { - // There was an error. ids is false and not an Object[] - Map[] messages = (Map[]) results.get("messages"); - String errorString = Arrays.stream(messages) // NOSONAR - .flatMap(m -> m.entrySet().stream()) - .map(e -> String.join(":", e.getKey(), e.getValue().toString())) - .collect(Collectors.joining("\n")); - throw new OdooApiException(errorString); - } - - // Should be in the same order as it was passed in - Object[] ids = (Object[]) results.get("ids"); - for (int i = 0; i < rows.size(); i++) { - Row row = rows.get(i); - row.put("id", ids[i]); - } - } - - /** - * Gets the number of records that satisfies the filter - * - * @param filter A filter collection that contains a list of filters to be - * applied - * @return The number of record count. - * @throws XmlRpcException - * @throws OdooApiException - */ - public int getObjectCount(FilterCollection filter) throws XmlRpcException, OdooApiException { - Integer count =0 ; - Object[] preparedFilters = validateFilters(filter); - - Response response = command.searchObject(modelName, preparedFilters, -1, -1, null, true); - if (response.isSuccessful()) { - count = Integer.parseInt(response.getResponseObject().toString()); - } - return count; - } - - /** - * * - * Combines the searchObject and readObject calls. Allows for easy read of - * all data - * - * @param filter A filter collection that contains a list of filters to be - * applied - * @param fields List of fields to return data for - * @return A collection of rows for an Odoo object - * @throws XmlRpcException - * @throws OdooApiException - */ - public RowCollection searchAndReadObject(FilterCollection filter, String[] fields) - throws XmlRpcException, OdooApiException { - return searchAndReadObject(filter, fields, -1, -1, ""); - } - - /** - * Combines the searchObject and readObject calls and returns rows in - * batches. Useful for multi-threaded ETL applications. - * - * @param filter A filter collection that contains a list of filters to be - * applied - * @param fields List of fields to return data for - * @param offset Number of records to skip. -1 for no offset. - * @param limit Maximum number of rows to return. -1 for no limit. - * @param order Field name to order on - * @return A collection of rows for an Odoo object - * @throws XmlRpcException - * @throws OdooApiException - */ - public RowCollection searchAndReadObject(final FilterCollection filter, final String[] fields, int offset, - int limit, String order) throws XmlRpcException, OdooApiException { - - String[] fieldArray = fields == null ? new String[]{} : fields; - Object[] preparedFilters = validateFilters(filter); - Object[] idList = null; - Response response = command.searchObject(modelName, preparedFilters, offset, limit, order, false); - if (response.isSuccessful()) { - idList = response.getResponseObjectAsArray(); - } - return readObject(idList, fieldArray); - - } - - private Object formatValueForWrite(Field fld, Object value) { - Object result; - if (value == null) { - result = false; - } else { - result = formatValueBasedOnFieldTypeForWrite(fld, value); - } - return result; - - } - - private Object formatValueBasedOnFieldTypeForWrite(Field fld, Object value) { - Object result; - switch (fld.getType()) { - case BOOLEAN: - result = value; - break; - case FLOAT: - result = Double.valueOf(value.toString()); - break; - case MANY2MANY: - result = formatManyToManyForWrite(value); - break; - case MANY2ONE: - case ONE2MANY: - case INTEGER: - result = formatIntegerForWrite(value); - break; - case DATE: - result = formatDateForWrite(value); - break; - case DATETIME: - result = formatDateTimeForWrite(value); - break; - default: - result = value.toString(); - break; - } - return result; - } - - private Object formatManyToManyForWrite(Object value) { - // For write, otherwise it is a comma separated list of strings used - // by import - if (value instanceof Object[]) { - Object[] tmp = new Object[]{6, 0, (Object[]) value}; - return new Object[][]{tmp}; - } else { - return value; - } - } - - private Object formatIntegerForWrite(Object value) { - // To make sure 1.0 is converted to 1 - return Double.valueOf(value.toString()).intValue(); - } - - private Object formatDateTimeForWrite(Object value) { - SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss"); - sdf.setTimeZone(TimeZone.getTimeZone("UTC")); - return sdf.format(value); - } - - private Object formatDateForWrite(Object value) { - SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd"); - sdf.setTimeZone(TimeZone.getTimeZone("UTC")); - return sdf.format(value); - } - - /** - * Writes a collection of rows to the database by calling the write function - * on the object the Row is holding data for - * - * @param rows Row collection to submit - * @param changesOnly Only changed values will be submitted to the database. - * @return An array of logicals. One for each row to indicate if the update - * was successful - * @throws OdooApiException - * @throws XmlRpcException - */ - public Boolean[] writeObject(final RowCollection rows, final boolean changesOnly) - throws OdooApiException, XmlRpcException { - Boolean[] returnValues = new Boolean[rows.size()]; - - for (int i = 0; i < rows.size(); i++) { - returnValues[i] = writeObject(rows.get(i), changesOnly); - } - - return returnValues; - } - - /** - * Writes a Row to the database by calling the write function on the object - * the Row is holding data for - * - * @param row Row to be committed - * @param changesOnly Only changed values will be submitted to the database. - * @return If the update was successful - * @throws OdooApiException - * @throws XmlRpcException - */ - public boolean writeObject(final Row row, boolean changesOnly) throws OdooApiException { - - Object idObj = row.get("id"); - - if (idObj == null || Integer.parseInt(idObj.toString()) <= 0) { - throw new OdooApiException("Please set the id field with the database ID of the object"); - } - - int id = Integer.parseInt(idObj.toString()); - - Map valueList = collectValues(row, changesOnly); - - if (valueList.size() == 0) { - return false; - } - - try { - - boolean success = command.writeObject(modelName, id, valueList); - if (success) { - row.changesApplied(); - } - return success; - - } catch (XmlRpcException e) { - throw new OdooApiException(e); - } - - } - - private Map collectValues(final Row row, boolean changesOnly) { - Map valueList = new HashMap<>(); - FieldCollection fields; - if (changesOnly) { - fields = row.getChangedFields(); - } else { - fields = row.getFields(); - } - - for (Field fld : fields) { - valueList.put(fld.getName(), formatValueForWrite(fld, row.get(fld))); - } - return valueList; - } - - /** - * Creates an Object on the Odoo server by calling the create function on - * the server. The id column is set on the row after the object was - * successfully created - * - * @param row Data row read data from to create the Object - * @throws OdooApiException - * @throws XmlRpcException - */ - public void createObject(final Row row) throws OdooApiException, XmlRpcException { - - HashMap valueList = new HashMap(); - for (Field fld : row.getFields()) { - valueList.put(fld.getName(), formatValueForWrite(fld, row.get(fld))); - } - - if (valueList.size() == 0) { - throw new OdooApiException("Row doesn't have any fields to update"); - } - - Object id = command.createObject(modelName, valueList); - - row.put("id", id); - row.changesApplied(); - - } - - /** - * Calls any function on an object that returns a field collection. ie. a - * row is retured as [{'name' : {'type' : 'char'}] The Odoo function must - * have the signature like (self, cr, uid, *param). - * - * @param functionName function to call - * @param parameters Additional parameters that will be passed to the object - * @return A field collection - * @throws XmlRpcException - * @throws OdooApiException - */ - public FieldCollection callFieldsFunction(String functionName, Object[] parameters) - throws XmlRpcException, OdooApiException { - Response response = command.callObjectFunction(modelName, functionName, parameters); - - return callFieldsFunction(response); - } - - @SuppressWarnings("unchecked") - private FieldCollection callFieldsFunction(Response response) { - if (!response.isSuccessful()) { - return new FieldCollection(); - } - - FieldCollection fieldCol = new FieldCollection(); - - Object[] results = response.getResponseObjectAsArray(); - // Go through the first row and fetch the fields name, description and - // type - if (results.length > 0) { - Map rowMap = (Map) results[0]; - for (Entry entry : rowMap.entrySet()) { - Map fldDetails; - if (entry.getValue() instanceof Map) { - fldDetails = (Map) entry.getValue(); - } else { - fldDetails = new HashMap<>(); - } - - completeFieldDetailsIfNecessary(entry, fldDetails); - fieldCol.add(new Field(entry.getKey(), fldDetails)); - } - } - - return fieldCol; - } - - private void completeFieldDetailsIfNecessary(Entry entry, Map fldDetails) { - if (!fldDetails.containsKey("name")) { - fldDetails.put("name", entry.getKey()); - } - if (!fldDetails.containsKey("description")) { - fldDetails.put("description", entry.getKey()); - } - - if (!fldDetails.containsKey("type")) { - Class type = entry.getValue().getClass(); - if (type == String.class) { - fldDetails.put("type", "char"); - } else if (type == Date.class) { - fldDetails.put("type", "date"); - } else if (type == Boolean.class) { - fldDetails.put("type", "boolean"); - } else if (type == Double.class) { - fldDetails.put("type", "float"); - } else if (type == Integer.class) { - fldDetails.put("type", "integer"); - } else { - fldDetails.put("type", "char"); - } - } - } - - /** - * Calls any function on an object. The first row is inspected to determine - * data fields and data types The Odoo function must have the signature like - * (self, cr, uid, *param) and return a dictionary or object. - * - * @param functionName function to call - * @param parameters Additional parameters that will be passed to the object - * @param fieldCol An option field collection to use. A new one will be - * built by inspecting the first row if it isn't specified (null). - * @return A row collection with the data - * @throws OdooApiException - */ - public RowCollection callFunction(String functionName, Object[] parameters, FieldCollection fieldCol) - throws OdooApiException { - Response response = command.callObjectFunction(modelName, functionName, parameters); - - if (!response.isSuccessful()) { - String message = "Failed to call function '" + functionName + "' with parameters '" - + Arrays.deepToString(parameters) + "' and FieldCollection '" + fieldCol + "' on object '" - + modelName + "'"; - throw new OdooApiException(message, response.getErrorCause()); - } - - Object[] results = response.getResponseObjectAsArray(); - - FieldCollection fieldCollection = fieldCol != null ? fieldCol : callFieldsFunction(response); - - return new RowCollection(results, fieldCollection); - } - - /** - * Executes a workflow by sending a signal to the workflow engine for a - * specific object. - * - * @param row Row that represents the object that the signal should be sent - * for - * @param signal Signal name to send - * @throws XmlRpcException - * @throws OdooApiException - */ - public void executeWorkflow(Row row, String signal) throws XmlRpcException, OdooApiException { - // Sanity check - checkSignalExists(signal); - - command.executeWorkflow(this.modelName, signal, row.getID()); - } - - /** - * Deletes objects from the Odoo Server - * - * @param rows Rows to delete - * @return If all rows were successfully deleted - * @throws XmlRpcException - */ - public boolean unlinkObject(RowCollection rows) throws XmlRpcException { - - Object[] ids = new Object[rows.size()]; - for (int i = 0; i < rows.size(); i++) { - ids[i] = rows.get(i).getID(); - } - - return this.command.unlinkObject(this.modelName, ids); - } - - /** - * Deletes objects from the Odoo Server - * - * @param row Row to delete - * @return If the row was successfully deleted - * @throws XmlRpcException - */ - public boolean unlinkObject(Row row) throws XmlRpcException { - RowCollection rows = new RowCollection(); - rows.add(row); - return this.unlinkObject(rows); - } + private final String modelName; + private final OdooCommand command; + private final FieldCollection allFields; + private final Version serverVersion; + + // Object name cache so the adapter doesn't have to reread model names from + // the database for every new object. + // Bulk loads/reads can become very slow if every adapter requires a call + // back to the server + private static final List objectNameCache = new ArrayList<>(); + + // Object workflow signal cache so the adapter doesn't have to reread signal + // names from the database for every workflow call. + private static final List signalCache = new ArrayList<>(); + + // Cache used to store the name_get result of an model to cater for + // many2many relations in the import function + // It is cleared every time the import function is called for a specific + // object + private final Map> modelNameCache = new ConcurrentHashMap<>(); + + /** + * Default constructor + * + * @param session Session object that will be used to make the calls + * @param modelName Model name that this adapter will work for. + * @throws XmlRpcException + * @throws OdooApiException + */ + public ObjectAdapter(Session session, String modelName) throws XmlRpcException, OdooApiException { + this(new OdooCommand(session), modelName, session.getServerVersion()); + } + + ObjectAdapter(OdooCommand command, String modelName, Version serverVersion) + throws OdooApiException, XmlRpcException { + this.command = command; + this.modelName = modelName; + this.serverVersion = serverVersion; + + validateModelExists(); + + allFields = getFields(); + } + + /** + * Validates a model name against entries in ir.model The function is + * synchronized to make use of a global (static) list of model names to increase + * speed + * + * @param command Command object to use + * @throws OdooApiException If the model could not be validated + */ + @SuppressWarnings("unchecked") + synchronized void validateModelExists() throws OdooApiException, XmlRpcException { + // If you can't find the object name, reload the cache. Somebody may + // have added a new module after the cache was created + // Ticket #1 from sourceforge + + Object[] ids = null; + if (objectNameCache.indexOf(modelName) < 0) { + clearModelNameCache(); + + if (!isUserPortal()) { + // TODO: Improve this part by using appropriate filterhelper + Response response = command.searchObject("ir.model", new Object[] {}); + if (response.isSuccessful()) { + ids = response.getResponseObjectAsArray(); + Object[] result = command.readObject("ir.model", ids, new String[] { "model" }); + for (Object row : result) { + objectNameCache.add(((HashMap) row).get("model").toString()); + } + } + }else { + System.err.println("This user seems to be a portal user. No control is done on the validity. Use it at your own risks!"); + objectNameCache.add(modelName); + } + + } + + if (objectNameCache.indexOf(modelName) < 0) { + throw new OdooApiException("Could not find model with name '" + modelName + "'"); + } + } + + private boolean isUserPortal() { + + return true; + } + + static void clearModelNameCache() { + objectNameCache.clear(); + } + + private void checkSignalExists(String signal) throws OdooApiException { + // If you can't find the signal, reload the cache. Somebody may have + // added a new module after the cache was created + String signalCombo = modelName + "#" + signal; + if (!signalCache.contains(signalCombo)) { + // Only one thread need to do the updating + synchronized (this.getClass()) { + // Cache may now contain the signal (updated by another thread + // while waiting at the synchronized gate). + if (!signalCache.contains(signalCombo)) { + refreshSignalCache(command); + } + } + } + + // If still not found, this is an error... + if (!signalCache.contains(signalCombo)) { + throw new OdooApiException( + "Could not find signal with name '" + signal + "' for object '" + modelName + "'"); + } + } + + @SuppressWarnings("unchecked") + private static void refreshSignalCache(OdooCommand command) throws OdooApiException { + signalCache.clear(); + try { + Response response = command.searchObject("workflow.transition", new Object[] {}); + Object[] ids = new Object[] {}; + if (response.isSuccessful()) { + ids = response.getResponseObjectAsArray(); + + Object[] result = command.readObject("workflow.transition", ids, new String[] { "signal", "wkf_id" }); + for (Object row : result) { + /* + * Get the parent workflow to work out get the object name + */ + // TODO: Check the latest syntax or workflow + int wkfId = Integer + .parseInt(((Object[]) ((HashMap) row).get("wkf_id"))[0].toString()); + Object[] workflow = command.readObject("workflow", new Object[] { wkfId }, new String[] { "osv" }); + + String obj = ((HashMap) workflow[0]).get("osv").toString(); + String sig = ((HashMap) row).get("signal").toString(); + signalCache.add(obj + "#" + sig); + } + } + } catch (XmlRpcException e) { + throw new OdooApiException("Could not validate signal name: ", e); + } + } + + /** + * Prepares a ROW object to be used for setting values in import/write methods + * + * @param fields Fields that should be included in the row definition + * @return An empty row with the specified fields + * @throws XmlRpcException + * @throws OdooApiException + */ + public Row getNewRow(FieldCollection fields) throws OdooApiException { + return new Row(new HashMap(), fields); + } + + /** + * Prepares a ROW object to be used for setting values in import/write methods. + * This method calls to the server to get the fieldCollection. Use + * getNewRow(FieldCollection fields) if you can to reduce the number of calls to + * the server for a bulk load. + * + * @param fields Fields that should be included in the row definition + * @return An empty row with the specified fields + * @throws XmlRpcException + * @throws OdooApiException + */ + public Row getNewRow(String[] fields) throws XmlRpcException, OdooApiException { + return getNewRow(getFields(fields)); + } + + /** + * Reads objects from the Odoo server if you already have the ID's. If you + * don't, use searchAndRead with filters. + * + * @param ids List of ids to fetch objects for + * @param fields List of fields to fetch data for + * @return A collection of rows for an Odoo object + * @throws XmlRpcException + * @throws OdooApiException + */ + public RowCollection readObject(Object[] ids, String[] fields) throws XmlRpcException, OdooApiException { + + // Faster to do read existing fields that to do a server call again + FieldCollection fieldCol = new FieldCollection(); + for (String fieldName : fields) { + for (Field fld : allFields) { + if (fld.getName().equals(fieldName)) { + fieldCol.add(fld); + } + } + } + + Object[] results = command.readObject(modelName, ids, fields); + + /** + * ** 18/04/2012 - PvdM Maybe reconsider this piece of code for later. Does it + * matter if it isn't sorted by ID? + * + * // Odoo doesn't use the sorting you pass (specified in the search function to + * get a sorted list of IDs). // When they fix it, remove this section of code + * ArrayList idList = new ArrayList (); for (Object id : ids){ + * idList.add(Integer.parseInt(id.toString())); } Object[] sortedResults = new + * Object[ids.length]; for (Object result : results){ + * + * @SuppressWarnings("unchecked") int id = null null null null null null + * Integer.parseInt(((HashMap)result).get("id").toString()); + * sortedResults[idList.indexOf(id)] = result; } ** + */ + return new RowCollection(results, fieldCol); + } + + /** + * * Fetches field information for the current Odoo object this adapter is + * linked to + * + * @return FieldCollecton data for all fields of the object + * @throws XmlRpcException + */ + public FieldCollection getFields() throws XmlRpcException { + return this.getFields(new String[] {}); + } + + /** + * * Fetches field names for the current Odoo object this adapter is linked to + * + * @return Array of field names + * @throws XmlRpcException + */ + public String[] getFieldNames() throws XmlRpcException { + FieldCollection fields = getFields(new String[] {}); + String[] fieldNames = new String[fields.size()]; + for (int i = 0; i < fields.size(); i++) { + fieldNames[i] = fields.get(i).getName(); + } + return fieldNames; + } + + /** + * * Fetches field information for the current Odoo object this adapter is + * linked to + * + * @param filterFields Only return data for files in the filter list + * @return FieldCollecton data for selected fields of the object + * @throws XmlRpcException + */ + @SuppressWarnings("unchecked") + public FieldCollection getFields(String[] filterFields) throws XmlRpcException { + FieldCollection collection = new FieldCollection(); + + Map fields = command.getFields(modelName, filterFields); + + for (String fieldName : fields.keySet()) { + Map fieldDetails = (Map) fields.get(fieldName); + collection.add(new Field(fieldName, fieldDetails)); + } + + return collection; + } + + /** + * Helper function to validate filter parameters and returns a filter object + * suitable for the Odoo search function by fixing data types and converting + * values where appropriate. + * + * @param filters FilterCollection containing the specified filters + * @return A validated filter Object[] correctly formatted for use by the Odoo + * search function + * @throws OdooApiException + */ + public Object[] validateFilters(final FilterCollection filters) throws OdooApiException { + + if (filters == null) { + return new Object[0]; + } + + ArrayList processedFilters = new ArrayList<>(); + + for (int i = 0; i < filters.getFilters().length; i++) { + Object filter = filters.getFilters()[i]; + + if (filter == null) { + throw new IllegalArgumentException("null filter parameter is not allowed"); + } + + // Is a logical operator + if (filter instanceof String) { + processedFilters.add(filter); + continue; + } + + // Is a comparison filter + Object[] filterObjects = (Object[]) filter; + if (!(filter instanceof Object[]) || filterObjects.length != 3) { + throw new OdooApiException("Filters aren't in the correct format. Please read the Odoo help."); + } + + String fieldName = filterObjects[0].toString(); + String comparison = filterObjects[1].toString(); + Object value = filterObjects[2]; + + Field fld = findFieldByName(fieldName); + + // Can't search on calculated fields + if (fld != null && fld.getFunc_method()) { + throw new OdooApiException("Can not search on function field " + fieldName); + } + + // Fix the value type if required for the Odoo server + if (!"id".equals(fieldName) && fld == null) { + throw new OdooApiException("Unknow filter field " + fieldName); + } else if ("is null".equals(comparison)) { + comparison = "="; + value = false; + } else if ("is not null".equals(comparison)) { + comparison = "!="; + value = false; + } else if (fld != null && fld.getType() == FieldType.BOOLEAN && !(value instanceof Boolean)) { + value = convertToBoolean(value); + } else if (fld != null && fld.getType() == FieldType.FLOAT && !(value instanceof Double)) { + value = Double.parseDouble(value.toString()); + } else if (fld != null && fld.getType() == FieldType.DATE && value instanceof Date) { + value = new SimpleDateFormat("yyyy-MM-dd").format((Date) value); + } else if (fld != null && fld.getType() == FieldType.DATETIME && value instanceof Date) { + value = new SimpleDateFormat("yyyy-MM-dd HH:mm").format((Date) value); + } else if ("=".equals(comparison)) { + + // If a integer field is not an integer in a '=' comparison, + // parse it as an int + if (!(value instanceof Integer)) { + if ("id".equals(fieldName) + || (fld != null && fld.getType() == FieldType.INTEGER && !(value instanceof Integer)) + || (fld != null && fld.getType() == FieldType.MANY2ONE && !(value instanceof Integer))) { + value = Integer.parseInt(value.toString()); + } + } + } else if ("in".equalsIgnoreCase(comparison)) { + if (value instanceof String) { + // Split by , where the , isn't preceded by a \ + String[] entries = value.toString().split("(? idToName; + if (!modelNameCache.containsKey(fld.getRelation())) { + idToName = new HashMap<>(); + Object[] ids = new Object[] {}; + Response response = command.searchObject(fld.getRelation(), new Object[] {}); + if (response.isSuccessful()) { + ids = response.getResponseObjectAsArray(); + Object[] names = command.nameGet(fld.getRelation(), ids); + for (int j = 0; j < ids.length; j++) { + Object[] nameValue = (Object[]) names[j]; + idToName.put(nameValue[0].toString(), nameValue[1].toString()); + } + } + + modelNameCache.put(fld.getRelation(), idToName); + } else { + idToName = modelNameCache.get(fld.getRelation()); + } + + String newValue = ""; + // Comma separated list of IDs + if (value instanceof String) { + for (String singleID : value.toString().split(",")) { + if (idToName.containsKey(singleID)) { + newValue = newValue + "," + idToName.get(singleID); + } else { + throw new OdooApiException("Could not find " + fld.getRelation() + " with ID " + singleID); + } + } + } else { + // Object[] of values -- default + for (Object singleID : (Object[]) value) { + if (idToName.containsKey(singleID.toString())) { + newValue = newValue + "," + idToName.get(singleID.toString()); + } else { + throw new OdooApiException( + "Could not find " + fld.getRelation() + " with ID " + singleID.toString()); + } + } + } + outputRow[columnIndex] = newValue.substring(1); + + break; + + // The import procedure expects most types to be strings + default: + outputRow[columnIndex] = value.toString(); + break; + } + } + + return outputRow; + } + + private String[] getFieldListForImport(FieldCollection currentFields) { + return Stream.concat(Stream.of(".id"), currentFields.stream().map(ObjectAdapter::getFieldNameForImport)) + .toArray(String[]::new); + + } + + private static String getFieldNameForImport(Field field) { + // Return field name, adding ".id" if type is MANY2ONE + return field.getType() == FieldType.MANY2ONE ? field.getName() + ".id" : field.getName(); + } + + /** + * Calls the import_data or load function on the server to bulk create/update + * records. + * + * The import_data function will be called on Odoo servers where the version + * number is < 7. The import_data function does not return IDs and therefore IDs + * will not be set on imported rows. + * + * The load function will be called for V7 and the IDs will be set on the + * imported rows. The load function was introduced in V7 and the import_data + * function deprecated. + * + * @param rows Rows to import. + * @return If the import was successful + * @throws XmlRpcException + * @throws OdooApiException + */ + public boolean importData(RowCollection rows) throws OdooApiException, XmlRpcException { + // Workaround: old and new rows can't be sent together + // together using the import_data or load function + if (this.serverVersion.getMajor() >= 7) { + RowCollection newRows = new RowCollection(); + RowCollection oldRows = new RowCollection(); + + for (int i = 0; i < rows.size(); i++) { + if (rows.get(i).getID() == 0) { + newRows.add(rows.get(i)); + } else { + oldRows.add(rows.get(i)); + } + } + + // If mixed rows, import old and new rows separately + if (!newRows.isEmpty() && !oldRows.isEmpty()) { + return this.importData(oldRows) && this.importData(newRows); + } + } + + modelNameCache.clear(); + + Object[][] importRows = new Object[rows.size()][]; + + for (int i = 0; i < rows.size(); i++) { + Row row = rows.get(i); + importRows[i] = fixImportData(row); + } + + if (this.serverVersion.getMajor() >= 7) { + // The load function was introduced in V7 and the import function + // deprecated + importDataV7(rows, importRows); + } else { + // Use older import rows function + importDataLegacy(rows, importRows); + } + + return true; + } + + private void importDataLegacy(RowCollection rows, Object[][] importRows) throws XmlRpcException, OdooApiException { + + String[] targetFieldList = getFieldListForImport(rows.get(0).getFields()); + + Object[] result = command.importData(modelName, targetFieldList, importRows); + + // Should return the number of rows committed. If there was an + // error, it returns -1 + if ((Integer) result[0] != importRows.length) { + throw new OdooApiException(result[2].toString() + "\nRow :" + result[1].toString() + ""); + } + } + + @SuppressWarnings("unchecked") + private void importDataV7(RowCollection rows, Object[][] importRows) throws XmlRpcException, OdooApiException { + + String[] targetFieldList = getFieldListForImport(rows.get(0).getFields()); + + // Remove the .id field for new rows. + if (this.serverVersion.getMajor() >= 7 && !rows.isEmpty() && rows.get(0).getID() == 0) { + String[] newTargetFieldList = new String[targetFieldList.length - 1]; + for (int i = 1; i < targetFieldList.length; i++) { + newTargetFieldList[i - 1] = targetFieldList[i]; + } + targetFieldList = newTargetFieldList; + + Object[][] newImportRows = new Object[rows.size()][]; + for (int i = 0; i < importRows.length; i++) { + Object[] newRow = new Object[importRows[i].length - 1]; + for (int j = 1; j < importRows[i].length; j++) { + newRow[j - 1] = importRows[i][j]; + } + newImportRows[i] = newRow; + } + importRows = newImportRows; + } + + Map results = command.load(modelName, targetFieldList, importRows); + + if (results.get("ids") instanceof Boolean) { + // There was an error. ids is false and not an Object[] + Map[] messages = (Map[]) results.get("messages"); + String errorString = Arrays.stream(messages) // NOSONAR + .flatMap(m -> m.entrySet().stream()).map(e -> String.join(":", e.getKey(), e.getValue().toString())) + .collect(Collectors.joining("\n")); + throw new OdooApiException(errorString); + } + + // Should be in the same order as it was passed in + Object[] ids = (Object[]) results.get("ids"); + for (int i = 0; i < rows.size(); i++) { + Row row = rows.get(i); + row.put("id", ids[i]); + } + } + + /** + * Gets the number of records that satisfies the filter + * + * @param filter A filter collection that contains a list of filters to be + * applied + * @return The number of record count. + * @throws XmlRpcException + * @throws OdooApiException + */ + public int getObjectCount(FilterCollection filter) throws XmlRpcException, OdooApiException { + Integer count = 0; + Object[] preparedFilters = validateFilters(filter); + + Response response = command.searchObject(modelName, preparedFilters, -1, -1, null, true); + if (response.isSuccessful()) { + count = Integer.parseInt(response.getResponseObject().toString()); + } + return count; + } + + /** + * * Combines the searchObject and readObject calls. Allows for easy read of all + * data + * + * @param filter A filter collection that contains a list of filters to be + * applied + * @param fields List of fields to return data for + * @return A collection of rows for an Odoo object + * @throws XmlRpcException + * @throws OdooApiException + */ + public RowCollection searchAndReadObject(FilterCollection filter, String[] fields) + throws XmlRpcException, OdooApiException { + return searchAndReadObject(filter, fields, -1, -1, ""); + } + + /** + * Combines the searchObject and readObject calls and returns rows in batches. + * Useful for multi-threaded ETL applications. + * + * @param filter A filter collection that contains a list of filters to be + * applied + * @param fields List of fields to return data for + * @param offset Number of records to skip. -1 for no offset. + * @param limit Maximum number of rows to return. -1 for no limit. + * @param order Field name to order on + * @return A collection of rows for an Odoo object + * @throws XmlRpcException + * @throws OdooApiException + */ + public RowCollection searchAndReadObject(final FilterCollection filter, final String[] fields, int offset, + int limit, String order) throws XmlRpcException, OdooApiException { + + String[] fieldArray = fields == null ? new String[] {} : fields; + Object[] preparedFilters = validateFilters(filter); + Object[] idList = null; + Response response = command.searchObject(modelName, preparedFilters, offset, limit, order, false); + if (response.isSuccessful()) { + idList = response.getResponseObjectAsArray(); + } + return readObject(idList, fieldArray); + + } + + private Object formatValueForWrite(Field fld, Object value) { + Object result; + if (value == null) { + result = false; + } else { + result = formatValueBasedOnFieldTypeForWrite(fld, value); + } + return result; + + } + + private Object formatValueBasedOnFieldTypeForWrite(Field fld, Object value) { + Object result; + switch (fld.getType()) { + case BOOLEAN: + result = value; + break; + case FLOAT: + result = Double.valueOf(value.toString()); + break; + case MANY2MANY: + result = formatManyToManyForWrite(value); + break; + case MANY2ONE: + case ONE2MANY: + case INTEGER: + result = formatIntegerForWrite(value); + break; + case DATE: + result = formatDateForWrite(value); + break; + case DATETIME: + result = formatDateTimeForWrite(value); + break; + default: + result = value.toString(); + break; + } + return result; + } + + private Object formatManyToManyForWrite(Object value) { + // For write, otherwise it is a comma separated list of strings used + // by import + if (value instanceof Object[]) { + Object[] tmp = new Object[] { 6, 0, (Object[]) value }; + return new Object[][] { tmp }; + } else { + return value; + } + } + + private Object formatIntegerForWrite(Object value) { + // To make sure 1.0 is converted to 1 + return Double.valueOf(value.toString()).intValue(); + } + + private Object formatDateTimeForWrite(Object value) { + SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss"); + sdf.setTimeZone(TimeZone.getTimeZone("UTC")); + return sdf.format(value); + } + + private Object formatDateForWrite(Object value) { + SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd"); + sdf.setTimeZone(TimeZone.getTimeZone("UTC")); + return sdf.format(value); + } + + /** + * Writes a collection of rows to the database by calling the write function on + * the object the Row is holding data for + * + * @param rows Row collection to submit + * @param changesOnly Only changed values will be submitted to the database. + * @return An array of logicals. One for each row to indicate if the update was + * successful + * @throws OdooApiException + * @throws XmlRpcException + */ + public Boolean[] writeObject(final RowCollection rows, final boolean changesOnly) + throws OdooApiException, XmlRpcException { + Boolean[] returnValues = new Boolean[rows.size()]; + + for (int i = 0; i < rows.size(); i++) { + returnValues[i] = writeObject(rows.get(i), changesOnly); + } + + return returnValues; + } + + /** + * Writes a Row to the database by calling the write function on the object the + * Row is holding data for + * + * @param row Row to be committed + * @param changesOnly Only changed values will be submitted to the database. + * @return If the update was successful + * @throws OdooApiException + * @throws XmlRpcException + */ + public boolean writeObject(final Row row, boolean changesOnly) throws OdooApiException { + + Object idObj = row.get("id"); + + if (idObj == null || Integer.parseInt(idObj.toString()) <= 0) { + throw new OdooApiException("Please set the id field with the database ID of the object"); + } + + int id = Integer.parseInt(idObj.toString()); + + Map valueList = collectValues(row, changesOnly); + + if (valueList.size() == 0) { + return false; + } + + try { + + boolean success = command.writeObject(modelName, id, valueList); + if (success) { + row.changesApplied(); + } + return success; + + } catch (XmlRpcException e) { + throw new OdooApiException(e); + } + + } + + private Map collectValues(final Row row, boolean changesOnly) { + Map valueList = new HashMap<>(); + FieldCollection fields; + if (changesOnly) { + fields = row.getChangedFields(); + } else { + fields = row.getFields(); + } + + for (Field fld : fields) { + valueList.put(fld.getName(), formatValueForWrite(fld, row.get(fld))); + } + return valueList; + } + + /** + * Creates an Object on the Odoo server by calling the create function on the + * server. The id column is set on the row after the object was successfully + * created + * + * @param row Data row read data from to create the Object + * @throws OdooApiException + * @throws XmlRpcException + */ + public void createObject(final Row row) throws OdooApiException, XmlRpcException { + + HashMap valueList = new HashMap(); + for (Field fld : row.getFields()) { + valueList.put(fld.getName(), formatValueForWrite(fld, row.get(fld))); + } + + if (valueList.size() == 0) { + throw new OdooApiException("Row doesn't have any fields to update"); + } + + Object id = command.createObject(modelName, valueList); + + row.put("id", id); + row.changesApplied(); + + } + + /** + * Calls any function on an object that returns a field collection. ie. a row is + * retured as [{'name' : {'type' : 'char'}] The Odoo function must have the + * signature like (self, cr, uid, *param). + * + * @param functionName function to call + * @param parameters Additional parameters that will be passed to the object + * @return A field collection + * @throws XmlRpcException + * @throws OdooApiException + */ + public FieldCollection callFieldsFunction(String functionName, Object[] parameters) + throws XmlRpcException, OdooApiException { + Response response = command.callObjectFunction(modelName, functionName, parameters); + + return callFieldsFunction(response); + } + + @SuppressWarnings("unchecked") + private FieldCollection callFieldsFunction(Response response) { + if (!response.isSuccessful()) { + return new FieldCollection(); + } + + FieldCollection fieldCol = new FieldCollection(); + + Object[] results = response.getResponseObjectAsArray(); + // Go through the first row and fetch the fields name, description and + // type + if (results.length > 0) { + Map rowMap = (Map) results[0]; + for (Entry entry : rowMap.entrySet()) { + Map fldDetails; + if (entry.getValue() instanceof Map) { + fldDetails = (Map) entry.getValue(); + } else { + fldDetails = new HashMap<>(); + } + + completeFieldDetailsIfNecessary(entry, fldDetails); + fieldCol.add(new Field(entry.getKey(), fldDetails)); + } + } + + return fieldCol; + } + + private void completeFieldDetailsIfNecessary(Entry entry, Map fldDetails) { + if (!fldDetails.containsKey("name")) { + fldDetails.put("name", entry.getKey()); + } + if (!fldDetails.containsKey("description")) { + fldDetails.put("description", entry.getKey()); + } + + if (!fldDetails.containsKey("type")) { + Class type = entry.getValue().getClass(); + if (type == String.class) { + fldDetails.put("type", "char"); + } else if (type == Date.class) { + fldDetails.put("type", "date"); + } else if (type == Boolean.class) { + fldDetails.put("type", "boolean"); + } else if (type == Double.class) { + fldDetails.put("type", "float"); + } else if (type == Integer.class) { + fldDetails.put("type", "integer"); + } else { + fldDetails.put("type", "char"); + } + } + } + + /** + * Calls any function on an object. The first row is inspected to determine data + * fields and data types The Odoo function must have the signature like (self, + * cr, uid, *param) and return a dictionary or object. + * + * @param functionName function to call + * @param parameters Additional parameters that will be passed to the object + * @param fieldCol An option field collection to use. A new one will be + * built by inspecting the first row if it isn't specified + * (null). + * @return A row collection with the data + * @throws OdooApiException + */ + public RowCollection callFunction(String functionName, Object[] parameters, FieldCollection fieldCol) + throws OdooApiException { + Response response = command.callObjectFunction(modelName, functionName, parameters); + + if (!response.isSuccessful()) { + String message = "Failed to call function '" + functionName + "' with parameters '" + + Arrays.deepToString(parameters) + "' and FieldCollection '" + fieldCol + "' on object '" + + modelName + "'"; + throw new OdooApiException(message, response.getErrorCause()); + } + + Object[] results = response.getResponseObjectAsArray(); + + FieldCollection fieldCollection = fieldCol != null ? fieldCol : callFieldsFunction(response); + + return new RowCollection(results, fieldCollection); + } + + /** + * Executes a workflow by sending a signal to the workflow engine for a specific + * object. + * + * @param row Row that represents the object that the signal should be sent + * for + * @param signal Signal name to send + * @throws XmlRpcException + * @throws OdooApiException + */ + public void executeWorkflow(Row row, String signal) throws XmlRpcException, OdooApiException { + // Sanity check + checkSignalExists(signal); + + command.executeWorkflow(this.modelName, signal, row.getID()); + } + + /** + * Deletes objects from the Odoo Server + * + * @param rows Rows to delete + * @return If all rows were successfully deleted + * @throws XmlRpcException + */ + public boolean unlinkObject(RowCollection rows) throws XmlRpcException { + + Object[] ids = new Object[rows.size()]; + for (int i = 0; i < rows.size(); i++) { + ids[i] = rows.get(i).getID(); + } + + return this.command.unlinkObject(this.modelName, ids); + } + + /** + * Deletes objects from the Odoo Server + * + * @param row Row to delete + * @return If the row was successfully deleted + * @throws XmlRpcException + */ + public boolean unlinkObject(Row row) throws XmlRpcException { + RowCollection rows = new RowCollection(); + rows.add(row); + return this.unlinkObject(rows); + } } diff --git a/src/main/java/com/odoojava/api/OdooCommand.java b/src/main/java/com/odoojava/api/OdooCommand.java index 0500200..ca1aea8 100644 --- a/src/main/java/com/odoojava/api/OdooCommand.java +++ b/src/main/java/com/odoojava/api/OdooCommand.java @@ -128,8 +128,14 @@ public Map getFields(String objectName, String[] filterFields) t */ public Object[] readObject(String objectName, Object[] ids, String[] fields) throws XmlRpcException { Object[] readResult; - if (this.session.getServerVersion().getMajor() >= 8) { + if (this.session.getServerVersion().getMajor() >= 8 && + this.session.getServerVersion().getMajor() < 10 ) { readResult = (Object[]) session.executeCommandWithContext(objectName, "read", new Object[]{ids, fields}); + } + else if (this.session.getServerVersion().getMajor() >= 10 ) { + //Signature of the odoo method added a load parameter + // https://github.com/odoo/odoo/blob/10.0/odoo/models.py#L2995 + readResult = (Object[]) session.executeCommandWithContext(objectName, "read", new Object[]{ids, fields, new String[] {}}); } else { //TODO: Have to be rewritten/deleted considering the previous call readResult = (Object[]) session.executeCommand(objectName, "read", new Object[]{ids, fields, session.getContext()});