View Javadoc
1   /**
2    * This file Copyright (c) 2013-2018 Magnolia International
3    * Ltd.  (http://www.magnolia-cms.com). All rights reserved.
4    *
5    *
6    * This file is dual-licensed under both the Magnolia
7    * Network Agreement and the GNU General Public License.
8    * You may elect to use one or the other of these licenses.
9    *
10   * This file is distributed in the hope that it will be
11   * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12   * implied warranty of MERCHANTABILITY or FITNESS FOR A
13   * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14   * Redistribution, except as permitted by whichever of the GPL
15   * or MNA you select, is prohibited.
16   *
17   * 1. For the GPL license (GPL), you can redistribute and/or
18   * modify this file under the terms of the GNU General
19   * Public License, Version 3, as published by the Free Software
20   * Foundation.  You should have received a copy of the GNU
21   * General Public License, Version 3 along with this program;
22   * if not, write to the Free Software Foundation, Inc., 51
23   * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24   *
25   * 2. For the Magnolia Network Agreement (MNA), this file
26   * and the accompanying materials are made available under the
27   * terms of the MNA which accompanies this distribution, and
28   * is available at http://www.magnolia-cms.com/mna.html
29   *
30   * Any modifications to this file must keep this entire header
31   * intact.
32   *
33   */
34  package info.magnolia.dam.app;
35  
36  import info.magnolia.dam.app.ui.field.configuration.EditAssetAppConfiguration;
37  
38  import java.util.ArrayList;
39  import java.util.List;
40  
41  import org.apache.commons.lang3.StringUtils;
42  
43  import com.google.common.net.MediaType;
44  
45  /**
46   * DAM app configuration bean.
47   */
48  public class DamAppConfiguration {
49  
50      private List<EditAssetAppConfiguration> editAssetAppConfigurations = new ArrayList<>();
51  
52      public List<EditAssetAppConfiguration> getEditAssetAppConfigurations() {
53          return editAssetAppConfigurations;
54      }
55  
56      public void setEditAssetAppConfigurations(List<EditAssetAppConfiguration> editAssetAppConfigurations) {
57          this.editAssetAppConfigurations = editAssetAppConfigurations;
58      }
59  
60      public void addEditAssetAppConfiguration(EditAssetAppConfiguration editAssetAppConfiguration) {
61          this.editAssetAppConfigurations.add(editAssetAppConfiguration);
62      }
63  
64      /**
65       * @return the {@link EditAssetAppConfiguration} configured for the requested mediaType.
66       * throw new IllegalArgumentException if no {@link EditAssetAppConfiguration} is found in configuration.
67       */
68      public EditAssetAppConfiguration getEditAssetAppConfigurationForMediaType(MediaType mediaType) {
69  
70          if (mediaType == null) {
71              throw new IllegalArgumentException("Requested mediaType must not be null");
72          }
73  
74          EditAssetAppConfiguration resolvedConfiguration = null;
75          MediaType bestCandidate = MediaType.ANY_TYPE;
76          for (EditAssetAppConfiguration configuration : editAssetAppConfigurations) {
77              for (MediaType configuredMediaType : configuration.getSupportedMediaTypes()) {
78                  if (mediaType.is(configuredMediaType)) {
79                      bestCandidate = getBestMatchingCandidate(bestCandidate, configuredMediaType, mediaType);
80                      if (bestCandidate == configuredMediaType) {
81                          resolvedConfiguration = configuration;
82                      }
83                  }
84              }
85          }
86          if(resolvedConfiguration == null) {
87              throw new IllegalArgumentException("Configuration do not define an EditAssetAppConfiguration for the following mediaType " + mediaType.toString());
88          }
89          return resolvedConfiguration;
90      }
91  
92      /**
93       * @return bets matching {@link MediaType} for 'reference' between 'candidate1' and 'candidate2'. If both candidate have the same matching average, return 'candidate1'.
94       */
95      MediaType getBestMatchingCandidate(MediaType candidate1, MediaType candidate2, MediaType reference) {
96          if(reference.equals(candidate1)) {
97              return candidate1;
98          }
99          if(reference.equals(candidate2)) {
100             return candidate2;
101         }
102 
103         if (voteOnMediaType(candidate1, reference) >= voteOnMediaType(candidate2, reference)) {
104             return candidate1;
105         }
106         return candidate2;
107     }
108 
109     int voteOnMediaType(MediaType candidate, MediaType reference) {
110         int res = 0;
111         if (!reference.parameters().isEmpty() && candidate.parameters().entries().containsAll(reference.parameters().entries())) {
112             res += 1;
113         }
114         if (StringUtils.equals(reference.type(), candidate.type())) {
115             res += 2;
116         }
117         if (StringUtils.equals(reference.subtype(), candidate.subtype())) {
118             res += 3;
119         }
120         return res;
121     }
122 }