summaryrefslogtreecommitdiff
path: root/src/plugins/preflighting.checkers/src/com/motorolamobility/preflighting/checkers/androidmarketfilters/MissingMinSdkCondition.java
blob: 7a3e80742d75d3c3e8ac9b8810afad5fd6c68247 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
/*
* Copyright (C) 2012 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*      http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.motorolamobility.preflighting.checkers.androidmarketfilters;

import java.util.List;

import org.w3c.dom.DOMException;
import org.w3c.dom.NamedNodeMap;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;

import com.motorolamobility.preflighting.checkers.i18n.CheckerNLS;
import com.motorolamobility.preflighting.core.applicationdata.ApplicationData;
import com.motorolamobility.preflighting.core.applicationdata.XMLElement;
import com.motorolamobility.preflighting.core.checker.condition.CanExecuteConditionStatus;
import com.motorolamobility.preflighting.core.checker.condition.Condition;
import com.motorolamobility.preflighting.core.checker.condition.ICondition;
import com.motorolamobility.preflighting.core.devicespecification.DeviceSpecification;
import com.motorolamobility.preflighting.core.exception.PreflightingCheckerException;
import com.motorolamobility.preflighting.core.internal.cond.utils.ConditionUtils;
import com.motorolamobility.preflighting.core.utils.CheckerUtils;
import com.motorolamobility.preflighting.core.utils.ManifestConstants;
import com.motorolamobility.preflighting.core.utils.XmlUtils;
import com.motorolamobility.preflighting.core.validation.ValidationManagerConfiguration;
import com.motorolamobility.preflighting.core.validation.ValidationResult;
import com.motorolamobility.preflighting.core.validation.ValidationResultData;

public class MissingMinSdkCondition extends Condition implements ICondition
{
    private XMLElement manifestElement;

    private ValidationManagerConfiguration valManagerConfig;

    /*
     * (non-Javadoc)
     * @see com.motorolamobility.preflighting.core.checker.condition.Condition#execute(com.motorolamobility.preflighting.core.applicationdata.ApplicationData, java.util.List, com.motorolamobility.preflighting.core.validation.ValidationManagerConfiguration, com.motorolamobility.preflighting.core.validation.ValidationResult)
     */
    @Override
    public void execute(ApplicationData data, List<DeviceSpecification> deviceSpecs,
            ValidationManagerConfiguration valManagerConfig, ValidationResult results)
            throws PreflightingCheckerException
    {
        this.valManagerConfig = valManagerConfig;
        manifestElement = data.getManifestElement();

        NodeList usesSdkList =
                manifestElement.getDocument().getElementsByTagName(ManifestConstants.USES_SDK_TAG);

        if (usesSdkList.getLength() > 0)
        {
            // Check if attribute exists.
            for (int i = 0; i < usesSdkList.getLength(); i++)
            {
                Node usesSdkNode = usesSdkList.item(i);
                NamedNodeMap map = usesSdkNode.getAttributes();

                checkIfAtributeIsMissing(results, usesSdkNode, map,
                        ManifestConstants.MIN_SDK_VERSION_ATTRIBUTE);
            }
        }
        else
        {
            ValidationResultData resultData =
                    new ValidationResultData(CheckerUtils.createFileToIssuesMap(
                            manifestElement.getFile(), 0), getSeverityLevel(),
                            CheckerNLS.AndroidMarketFiltersChecker_missingMinSdkVersion_Issue,
                            CheckerNLS.AndroidMarketFiltersChecker_missingMinSdkVersion_Suggestion,
                            getId());
            resultData.setInfoURL(ConditionUtils.getDescriptionLink(getChecker().getId(), getId(),
                    valManagerConfig));
            resultData.setMarkerType(getMarkerType());
            results.addValidationResult(resultData);
        }

    }

    /**
     * Checks if the attribute name in the XML is not existent (null) or value
     * empty
     * 
     * @param map
     *            list of attribute from one XML element
     * @throws PreflightingCheckerException
     */
    private void checkIfAtributeIsMissing(ValidationResult results, Node manifestNode,
            NamedNodeMap map, String attributeName) throws PreflightingCheckerException
    {
        Node atr = map.getNamedItem(attributeName);
        try
        {
            if ((atr == null) || (atr.getNodeValue().trim().length() == 0))
            {
                int currentIssuedLine = manifestElement.getNodeLineNumber(manifestNode);
                ValidationResultData resultData =
                        new ValidationResultData(
                                CheckerUtils.createFileToIssuesMap(manifestElement.getFile(),
                                        currentIssuedLine),
                                getSeverityLevel(),
                                CheckerNLS.AndroidMarketFiltersChecker_missingMinSdkVersion_Issue,
                                CheckerNLS.AndroidMarketFiltersChecker_missingMinSdkVersion_Suggestion,
                                getId());
                resultData.setInfoURL(ConditionUtils.getDescriptionLink(getChecker().getId(),
                        getId(), valManagerConfig));
                resultData.setPreview(XmlUtils.getXMLNodeAsString(manifestNode, false));
                resultData.setMarkerType(getMarkerType());
                results.addValidationResult(resultData);
            }
        }
        catch (DOMException e)
        {
            // Error retrieving attribute
            throw new PreflightingCheckerException(CheckerNLS.bind(
                    CheckerNLS.AndroidMarketFiltersChecker_Exception_Getting_Manifest_Attribute,
                    attributeName), e);
        }
    }

    /*
     * (non-Javadoc)
     * @see com.motorolamobility.preflighting.core.checker.condition.Condition#canExecute(com.motorolamobility.preflighting.core.applicationdata.ApplicationData, java.util.List)
     */
    @Override
    public CanExecuteConditionStatus canExecute(ApplicationData data,
            List<DeviceSpecification> deviceSpecs) throws PreflightingCheckerException
    {
        return CheckerUtils.isAndroidManifestFileExistent(data, getId());
    }

}