001    /**
002     * Copyright (c) 2000-present Liferay, Inc. All rights reserved.
003     *
004     * This library is free software; you can redistribute it and/or modify it under
005     * the terms of the GNU Lesser General Public License as published by the Free
006     * Software Foundation; either version 2.1 of the License, or (at your option)
007     * any later version.
008     *
009     * This library is distributed in the hope that it will be useful, but WITHOUT
010     * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
011     * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
012     * details.
013     */
014    
015    package com.liferay.portal.kernel.service.persistence.impl;
016    
017    import com.liferay.portal.kernel.cache.MultiVMPoolUtil;
018    import com.liferay.portal.kernel.cache.PortalCache;
019    import com.liferay.portal.kernel.cache.PortalCacheHelperUtil;
020    import com.liferay.portal.kernel.dao.jdbc.MappingSqlQuery;
021    import com.liferay.portal.kernel.dao.jdbc.MappingSqlQueryFactoryUtil;
022    import com.liferay.portal.kernel.dao.jdbc.ParamSetter;
023    import com.liferay.portal.kernel.dao.jdbc.RowMapper;
024    import com.liferay.portal.kernel.dao.jdbc.SqlUpdate;
025    import com.liferay.portal.kernel.dao.jdbc.SqlUpdateFactoryUtil;
026    import com.liferay.portal.kernel.exception.NoSuchModelException;
027    import com.liferay.portal.kernel.exception.SystemException;
028    import com.liferay.portal.kernel.model.BaseModel;
029    import com.liferay.portal.kernel.model.ModelListener;
030    import com.liferay.portal.kernel.service.persistence.BasePersistence;
031    import com.liferay.portal.kernel.util.ArrayUtil;
032    import com.liferay.portal.kernel.util.ListUtil;
033    import com.liferay.portal.kernel.util.OrderByComparator;
034    
035    import java.util.ArrayList;
036    import java.util.Arrays;
037    import java.util.Collections;
038    import java.util.List;
039    
040    import javax.sql.DataSource;
041    
042    /**
043     * @author Shuyang Zhou
044     */
045    public class TableMapperImpl<L extends BaseModel<L>, R extends BaseModel<R>>
046            implements TableMapper<L, R> {
047    
048            public TableMapperImpl(
049                    String tableName, String companyColumnName, String leftColumnName,
050                    String rightColumnName, BasePersistence<L> leftBasePersistence,
051                    BasePersistence<R> rightBasePersistence) {
052    
053                    this.leftColumnName = leftColumnName;
054                    this.rightColumnName = rightColumnName;
055                    this.leftBasePersistence = leftBasePersistence;
056                    this.rightBasePersistence = rightBasePersistence;
057    
058                    DataSource dataSource = leftBasePersistence.getDataSource();
059    
060                    addTableMappingSqlUpdate = SqlUpdateFactoryUtil.getSqlUpdate(
061                            dataSource,
062                            "INSERT INTO " + tableName + " (" + companyColumnName + ", " +
063                                    leftColumnName + ", " + rightColumnName + ") VALUES (?, ?, ?)",
064                            ParamSetter.BIGINT, ParamSetter.BIGINT, ParamSetter.BIGINT);
065                    deleteLeftPrimaryKeyTableMappingsSqlUpdate =
066                            SqlUpdateFactoryUtil.getSqlUpdate(
067                                    dataSource,
068                                    "DELETE FROM " + tableName + " WHERE " + leftColumnName +
069                                            " = ?",
070                                    ParamSetter.BIGINT);
071                    deleteRightPrimaryKeyTableMappingsSqlUpdate =
072                            SqlUpdateFactoryUtil.getSqlUpdate(
073                                    dataSource,
074                                    "DELETE FROM " + tableName + " WHERE " + rightColumnName +
075                                            " = ?",
076                                    ParamSetter.BIGINT);
077                    deleteTableMappingSqlUpdate = SqlUpdateFactoryUtil.getSqlUpdate(
078                            dataSource,
079                            "DELETE FROM " + tableName + " WHERE " + leftColumnName +
080                                    " = ? AND " + rightColumnName + " = ?",
081                            ParamSetter.BIGINT, ParamSetter.BIGINT);
082                    getLeftPrimaryKeysSqlQuery =
083                            MappingSqlQueryFactoryUtil.getMappingSqlQuery(
084                                    dataSource,
085                                    "SELECT " + leftColumnName + " FROM " + tableName + " WHERE " +
086                                            rightColumnName + " = ?",
087                                    RowMapper.PRIMARY_KEY, ParamSetter.BIGINT);
088                    getRightPrimaryKeysSqlQuery =
089                            MappingSqlQueryFactoryUtil.getMappingSqlQuery(
090                                    dataSource,
091                                    "SELECT " + rightColumnName + " FROM " + tableName + " WHERE " +
092                                            leftColumnName + " = ?",
093                                    RowMapper.PRIMARY_KEY, ParamSetter.BIGINT);
094    
095                    leftToRightPortalCache = MultiVMPoolUtil.getPortalCache(
096                            TableMapper.class.getName() + "-" + tableName + "-LeftToRight");
097                    rightToLeftPortalCache = MultiVMPoolUtil.getPortalCache(
098                            TableMapper.class.getName() + "-" + tableName + "-RightToLeft");
099            }
100    
101            @Override
102            public boolean addTableMapping(
103                    long companyId, long leftPrimaryKey, long rightPrimaryKey) {
104    
105                    if (containsTableMapping(leftPrimaryKey, rightPrimaryKey, false)) {
106                            return false;
107                    }
108    
109                    leftToRightPortalCache.remove(leftPrimaryKey);
110                    rightToLeftPortalCache.remove(rightPrimaryKey);
111    
112                    _doAddTableMapping(companyId, leftPrimaryKey, rightPrimaryKey);
113    
114                    return true;
115            }
116    
117            @Override
118            public long[] addTableMappings(
119                    long companyId, long leftPrimaryKey, long[] rightPrimaryKeys) {
120    
121                    List<Long> addedRightPrimaryKeys = new ArrayList<>();
122                    long[] currentRightPrimaryKeys = getPrimaryKeys(
123                            leftToRightPortalCache, getRightPrimaryKeysSqlQuery, leftPrimaryKey,
124                            false);
125    
126                    for (long rightPrimaryKey : rightPrimaryKeys) {
127                            if (Arrays.binarySearch(currentRightPrimaryKeys, rightPrimaryKey) <
128                                            0) {
129    
130                                    addedRightPrimaryKeys.add(rightPrimaryKey);
131    
132                                    rightToLeftPortalCache.remove(rightPrimaryKey);
133    
134                                    _doAddTableMapping(companyId, leftPrimaryKey, rightPrimaryKey);
135                            }
136                    }
137    
138                    if (!addedRightPrimaryKeys.isEmpty()) {
139                            leftToRightPortalCache.remove(leftPrimaryKey);
140                    }
141    
142                    return ArrayUtil.toLongArray(addedRightPrimaryKeys);
143            }
144    
145            @Override
146            public long[] addTableMappings(
147                    long companyId, long[] leftPrimaryKeys, long rightPrimaryKey) {
148    
149                    List<Long> addedLeftPrimaryKeys = new ArrayList<>();
150                    long[] currentLeftPrimaryKeys = getPrimaryKeys(
151                            rightToLeftPortalCache, getLeftPrimaryKeysSqlQuery, rightPrimaryKey,
152                            false);
153    
154                    for (long leftPrimaryKey : leftPrimaryKeys) {
155                            if (Arrays.binarySearch(currentLeftPrimaryKeys, leftPrimaryKey) <
156                                            0) {
157    
158                                    addedLeftPrimaryKeys.add(leftPrimaryKey);
159    
160                                    leftToRightPortalCache.remove(leftPrimaryKey);
161    
162                                    _doAddTableMapping(companyId, leftPrimaryKey, rightPrimaryKey);
163                            }
164                    }
165    
166                    if (!addedLeftPrimaryKeys.isEmpty()) {
167                            rightToLeftPortalCache.remove(rightPrimaryKey);
168                    }
169    
170                    return ArrayUtil.toLongArray(addedLeftPrimaryKeys);
171            }
172    
173            @Override
174            public boolean containsTableMapping(
175                    long leftPrimaryKey, long rightPrimaryKey) {
176    
177                    return containsTableMapping(leftPrimaryKey, rightPrimaryKey, true);
178            }
179    
180            @Override
181            public int deleteLeftPrimaryKeyTableMappings(long leftPrimaryKey) {
182                    return deleteTableMappings(
183                            leftBasePersistence, rightBasePersistence, leftToRightPortalCache,
184                            rightToLeftPortalCache, getRightPrimaryKeysSqlQuery,
185                            deleteLeftPrimaryKeyTableMappingsSqlUpdate, leftPrimaryKey);
186            }
187    
188            @Override
189            public int deleteRightPrimaryKeyTableMappings(long rightPrimaryKey) {
190                    return deleteTableMappings(
191                            rightBasePersistence, leftBasePersistence, rightToLeftPortalCache,
192                            leftToRightPortalCache, getLeftPrimaryKeysSqlQuery,
193                            deleteRightPrimaryKeyTableMappingsSqlUpdate, rightPrimaryKey);
194            }
195    
196            @Override
197            public boolean deleteTableMapping(
198                    long leftPrimaryKey, long rightPrimaryKey) {
199    
200                    if (!containsTableMapping(leftPrimaryKey, rightPrimaryKey, false)) {
201                            return false;
202                    }
203    
204                    leftToRightPortalCache.remove(leftPrimaryKey);
205                    rightToLeftPortalCache.remove(rightPrimaryKey);
206    
207                    return _doDeleteTableMapping(leftPrimaryKey, rightPrimaryKey);
208            }
209    
210            @Override
211            public long[] deleteTableMappings(
212                    long leftPrimaryKey, long[] rightPrimaryKeys) {
213    
214                    boolean clearCache = false;
215                    long[] currentRightPrimaryKeys = getPrimaryKeys(
216                            leftToRightPortalCache, getRightPrimaryKeysSqlQuery, leftPrimaryKey,
217                            false);
218                    List<Long> deletedRightPrimaryKeys = new ArrayList<>();
219    
220                    for (long rightPrimaryKey : rightPrimaryKeys) {
221                            if (Arrays.binarySearch(currentRightPrimaryKeys, rightPrimaryKey) >=
222                                            0) {
223    
224                                    clearCache = true;
225    
226                                    rightToLeftPortalCache.remove(rightPrimaryKey);
227    
228                                    if (_doDeleteTableMapping(leftPrimaryKey, rightPrimaryKey)) {
229                                            deletedRightPrimaryKeys.add(rightPrimaryKey);
230                                    }
231                            }
232                    }
233    
234                    if (clearCache) {
235                            leftToRightPortalCache.remove(leftPrimaryKey);
236                    }
237    
238                    return ArrayUtil.toLongArray(deletedRightPrimaryKeys);
239            }
240    
241            @Override
242            public long[] deleteTableMappings(
243                    long[] leftPrimaryKeys, long rightPrimaryKey) {
244    
245                    boolean clearCache = false;
246                    long[] currentLeftPrimaryKeys = getPrimaryKeys(
247                            rightToLeftPortalCache, getLeftPrimaryKeysSqlQuery, rightPrimaryKey,
248                            false);
249                    List<Long> deletedLeftPrimaryKeys = new ArrayList<>();
250    
251                    for (long leftPrimaryKey : leftPrimaryKeys) {
252                            if (Arrays.binarySearch(currentLeftPrimaryKeys, leftPrimaryKey) >=
253                                            0) {
254    
255                                    leftToRightPortalCache.remove(leftPrimaryKey);
256    
257                                    clearCache = true;
258    
259                                    if (_doDeleteTableMapping(leftPrimaryKey, rightPrimaryKey)) {
260                                            deletedLeftPrimaryKeys.add(leftPrimaryKey);
261                                    }
262                            }
263                    }
264    
265                    if (clearCache) {
266                            rightToLeftPortalCache.remove(rightPrimaryKey);
267                    }
268    
269                    return ArrayUtil.toLongArray(deletedLeftPrimaryKeys);
270            }
271    
272            @Override
273            public void destroy() {
274                    MultiVMPoolUtil.removePortalCache(
275                            leftToRightPortalCache.getPortalCacheName());
276                    MultiVMPoolUtil.removePortalCache(
277                            rightToLeftPortalCache.getPortalCacheName());
278            }
279    
280            @Override
281            public List<L> getLeftBaseModels(
282                    long rightPrimaryKey, int start, int end, OrderByComparator<L> obc) {
283    
284                    return getBaseModels(
285                            rightToLeftPortalCache, getLeftPrimaryKeysSqlQuery, rightPrimaryKey,
286                            leftBasePersistence, start, end, obc);
287            }
288    
289            @Override
290            public long[] getLeftPrimaryKeys(long rightPrimaryKey) {
291                    return getPrimaryKeys(
292                            rightToLeftPortalCache, getLeftPrimaryKeysSqlQuery, rightPrimaryKey,
293                            true);
294            }
295    
296            @Override
297            public TableMapper<R, L> getReverseTableMapper() {
298                    return reverseTableMapper;
299            }
300    
301            @Override
302            public List<R> getRightBaseModels(
303                    long leftPrimaryKey, int start, int end, OrderByComparator<R> obc) {
304    
305                    return getBaseModels(
306                            leftToRightPortalCache, getRightPrimaryKeysSqlQuery, leftPrimaryKey,
307                            rightBasePersistence, start, end, obc);
308            }
309    
310            @Override
311            public long[] getRightPrimaryKeys(long leftPrimaryKey) {
312                    return getPrimaryKeys(
313                            leftToRightPortalCache, getRightPrimaryKeysSqlQuery, leftPrimaryKey,
314                            true);
315            }
316    
317            @Override
318            public boolean matches(String leftColumnName, String rightColumnName) {
319                    if (this.leftColumnName.equals(leftColumnName) &&
320                            this.rightColumnName.equals(rightColumnName)) {
321    
322                            return true;
323                    }
324    
325                    return false;
326            }
327    
328            public void setReverseTableMapper(TableMapper<R, L> reverseTableMapper) {
329                    this.reverseTableMapper = reverseTableMapper;
330            }
331    
332            protected static <M extends BaseModel<M>, S extends BaseModel<S>> int
333                    deleteTableMappings(
334                            BasePersistence<M> masterBasePersistence,
335                            BasePersistence<S> slaveBasePersistence,
336                            PortalCache<Long, long[]> masterToSlavePortalCache,
337                            PortalCache<Long, long[]> slaveToMasterPortalCache,
338                            MappingSqlQuery<Long> mappingSqlQuery, SqlUpdate deleteSqlUpdate,
339                            long masterPrimaryKey) {
340    
341                    ModelListener<M>[] masterModelListeners =
342                            masterBasePersistence.getListeners();
343                    ModelListener<S>[] slaveModelListeners =
344                            slaveBasePersistence.getListeners();
345    
346                    long[] slavePrimaryKeys = getPrimaryKeys(
347                            masterToSlavePortalCache, mappingSqlQuery, masterPrimaryKey, false);
348    
349                    Class<M> masterModelClass = null;
350                    Class<S> slaveModelClass = null;
351    
352                    if ((masterModelListeners.length > 0) ||
353                            (slaveModelListeners.length > 0)) {
354    
355                            masterModelClass = masterBasePersistence.getModelClass();
356                            slaveModelClass = slaveBasePersistence.getModelClass();
357    
358                            for (long slavePrimaryKey : slavePrimaryKeys) {
359                                    for (ModelListener<M> masterModelListener :
360                                                    masterModelListeners) {
361    
362                                            masterModelListener.onBeforeRemoveAssociation(
363                                                    masterPrimaryKey, slaveModelClass.getName(),
364                                                    slavePrimaryKey);
365                                    }
366    
367                                    for (ModelListener<S> slaveModelListener :
368                                                    slaveModelListeners) {
369    
370                                            slaveModelListener.onBeforeRemoveAssociation(
371                                                    slavePrimaryKey, masterModelClass.getName(),
372                                                    masterPrimaryKey);
373                                    }
374                            }
375                    }
376    
377                    masterToSlavePortalCache.remove(masterPrimaryKey);
378    
379                    for (long slavePrimaryKey : slavePrimaryKeys) {
380                            slaveToMasterPortalCache.remove(slavePrimaryKey);
381                    }
382    
383                    int rowCount = 0;
384    
385                    try {
386                            rowCount = deleteSqlUpdate.update(masterPrimaryKey);
387                    }
388                    catch (Exception e) {
389                            throw new SystemException(e);
390                    }
391    
392                    if ((masterModelListeners.length > 0) ||
393                            (slaveModelListeners.length > 0)) {
394    
395                            for (long slavePrimaryKey : slavePrimaryKeys) {
396                                    for (ModelListener<M> masterModelListener :
397                                                    masterModelListeners) {
398    
399                                            masterModelListener.onAfterRemoveAssociation(
400                                                    masterPrimaryKey, slaveModelClass.getName(),
401                                                    slavePrimaryKey);
402                                    }
403    
404                                    for (ModelListener<S> slaveModelListener :
405                                                    slaveModelListeners) {
406    
407                                            slaveModelListener.onAfterRemoveAssociation(
408                                                    slavePrimaryKey, masterModelClass.getName(),
409                                                    masterPrimaryKey);
410                                    }
411                            }
412                    }
413    
414                    return rowCount;
415            }
416    
417            protected static <T extends BaseModel<T>> List<T> getBaseModels(
418                    PortalCache<Long, long[]> portalCache,
419                    MappingSqlQuery<Long> mappingSqlQuery, long masterPrimaryKey,
420                    BasePersistence<T> slaveBasePersistence, int start, int end,
421                    OrderByComparator<T> obc) {
422    
423                    long[] slavePrimaryKeys = getPrimaryKeys(
424                            portalCache, mappingSqlQuery, masterPrimaryKey, true);
425    
426                    if (slavePrimaryKeys.length == 0) {
427                            return Collections.emptyList();
428                    }
429    
430                    List<T> slaveBaseModels = new ArrayList<>(slavePrimaryKeys.length);
431    
432                    try {
433                            for (long slavePrimaryKey : slavePrimaryKeys) {
434                                    slaveBaseModels.add(
435                                            slaveBasePersistence.findByPrimaryKey(slavePrimaryKey));
436                            }
437                    }
438                    catch (NoSuchModelException nsme) {
439                            throw new SystemException(nsme);
440                    }
441    
442                    if (obc != null) {
443                            Collections.sort(slaveBaseModels, obc);
444                    }
445    
446                    return ListUtil.subList(slaveBaseModels, start, end);
447            }
448    
449            protected static long[] getPrimaryKeys(
450                    PortalCache<Long, long[]> portalCache,
451                    MappingSqlQuery<Long> mappingSqlQuery, long masterPrimaryKey,
452                    boolean updateCache) {
453    
454                    long[] primaryKeys = portalCache.get(masterPrimaryKey);
455    
456                    if (primaryKeys == null) {
457                            List<Long> primaryKeysList = null;
458    
459                            try {
460                                    primaryKeysList = mappingSqlQuery.execute(masterPrimaryKey);
461                            }
462                            catch (Exception e) {
463                                    throw new SystemException(e);
464                            }
465    
466                            primaryKeys = new long[primaryKeysList.size()];
467    
468                            for (int i = 0; i < primaryKeys.length; i++) {
469                                    primaryKeys[i] = primaryKeysList.get(i);
470                            }
471    
472                            Arrays.sort(primaryKeys);
473    
474                            if (updateCache) {
475                                    PortalCacheHelperUtil.putWithoutReplicator(
476                                            portalCache, masterPrimaryKey, primaryKeys);
477                            }
478                    }
479    
480                    return primaryKeys;
481            }
482    
483            protected boolean containsTableMapping(
484                    long leftPrimaryKey, long rightPrimaryKey, boolean updateCache) {
485    
486                    long[] rightPrimaryKeys = getPrimaryKeys(
487                            leftToRightPortalCache, getRightPrimaryKeysSqlQuery, leftPrimaryKey,
488                            updateCache);
489    
490                    if (Arrays.binarySearch(rightPrimaryKeys, rightPrimaryKey) < 0) {
491                            return false;
492                    }
493                    else {
494                            return true;
495                    }
496            }
497    
498            protected SqlUpdate addTableMappingSqlUpdate;
499            protected SqlUpdate deleteLeftPrimaryKeyTableMappingsSqlUpdate;
500            protected SqlUpdate deleteRightPrimaryKeyTableMappingsSqlUpdate;
501            protected SqlUpdate deleteTableMappingSqlUpdate;
502            protected MappingSqlQuery<Long> getLeftPrimaryKeysSqlQuery;
503            protected MappingSqlQuery<Long> getRightPrimaryKeysSqlQuery;
504            protected BasePersistence<L> leftBasePersistence;
505            protected String leftColumnName;
506            protected PortalCache<Long, long[]> leftToRightPortalCache;
507            protected TableMapper<R, L> reverseTableMapper;
508            protected BasePersistence<R> rightBasePersistence;
509            protected String rightColumnName;
510            protected PortalCache<Long, long[]> rightToLeftPortalCache;
511    
512            private void _doAddTableMapping(
513                    long companyId, long leftPrimaryKey, long rightPrimaryKey) {
514    
515                    Class<R> rightModelClass = rightBasePersistence.getModelClass();
516    
517                    ModelListener<L>[] leftModelListeners =
518                            leftBasePersistence.getListeners();
519    
520                    for (ModelListener<L> leftModelListener : leftModelListeners) {
521                            leftModelListener.onBeforeAddAssociation(
522                                    leftPrimaryKey, rightModelClass.getName(), rightPrimaryKey);
523                    }
524    
525                    Class<L> leftModelClass = leftBasePersistence.getModelClass();
526    
527                    ModelListener<R>[] rightModelListeners =
528                            rightBasePersistence.getListeners();
529    
530                    for (ModelListener<R> rightModelListener : rightModelListeners) {
531                            rightModelListener.onBeforeAddAssociation(
532                                    rightPrimaryKey, leftModelClass.getName(), leftPrimaryKey);
533                    }
534    
535                    try {
536                            addTableMappingSqlUpdate.update(
537                                    companyId, leftPrimaryKey, rightPrimaryKey);
538                    }
539                    catch (Exception e) {
540                            throw new SystemException(e);
541                    }
542    
543                    for (ModelListener<L> leftModelListener : leftModelListeners) {
544                            leftModelListener.onAfterAddAssociation(
545                                    leftPrimaryKey, rightModelClass.getName(), rightPrimaryKey);
546                    }
547    
548                    for (ModelListener<R> rightModelListener : rightModelListeners) {
549                            rightModelListener.onAfterAddAssociation(
550                                    rightPrimaryKey, leftModelClass.getName(), leftPrimaryKey);
551                    }
552            }
553    
554            private boolean _doDeleteTableMapping(
555                    long leftPrimaryKey, long rightPrimaryKey) {
556    
557                    Class<R> rightModelClass = rightBasePersistence.getModelClass();
558    
559                    ModelListener<L>[] leftModelListeners =
560                            leftBasePersistence.getListeners();
561    
562                    for (ModelListener<L> leftModelListener : leftModelListeners) {
563                            leftModelListener.onBeforeRemoveAssociation(
564                                    leftPrimaryKey, rightModelClass.getName(), rightPrimaryKey);
565                    }
566    
567                    Class<L> leftModelClass = leftBasePersistence.getModelClass();
568    
569                    ModelListener<R>[] rightModelListeners =
570                            rightBasePersistence.getListeners();
571    
572                    for (ModelListener<R> rightModelListener : rightModelListeners) {
573                            rightModelListener.onBeforeRemoveAssociation(
574                                    rightPrimaryKey, leftModelClass.getName(), leftPrimaryKey);
575                    }
576    
577                    int rowCount = 0;
578    
579                    try {
580                            rowCount = deleteTableMappingSqlUpdate.update(
581                                    leftPrimaryKey, rightPrimaryKey);
582                    }
583                    catch (Exception e) {
584                            throw new SystemException(e);
585                    }
586    
587                    if (rowCount > 0) {
588                            for (ModelListener<L> leftModelListener : leftModelListeners) {
589                                    leftModelListener.onAfterRemoveAssociation(
590                                            leftPrimaryKey, rightModelClass.getName(), rightPrimaryKey);
591                            }
592    
593                            for (ModelListener<R> rightModelListener : rightModelListeners) {
594                                    rightModelListener.onAfterRemoveAssociation(
595                                            rightPrimaryKey, leftModelClass.getName(), leftPrimaryKey);
596                            }
597    
598                            return true;
599                    }
600    
601                    return false;
602            }
603    
604    }