Split ProGuard file into two halves

This changeset splits the proguard.cfg into two halves:

(1) All the general Android settings go into
    $ANDROID_SDK/proguard/proguard-android.txt.

    This defines shrinking rules like keep custom views, etc. The
    crucial point is that this information is maintained and updated
    by Tools updates, so whenever new APIs are added to Android, or
    whenever bugs are found in the configuration such as flags needed
    to work with Dalvik, we can make the updates - we don't have old
    snapshots living on in projects.

(2) Any project specific settings go to proguard-project.txt in the
    project.

(3) The proguard.config property in project.properties now refers to a
    *path* of configuration files, which are all passed to ProGuard in
    the given order. The code which processes this setting will
    substitute android.sdk.home and user.home variables, so the path
    does not have to be hardcoded to point to the project-android.txt
    file.

    The default project templates have been updated to include a
    commented out configuration setting up proguard as described
    above.

The default proguard file name was changed from proguard.cfg to
proguard-project.txt such that it can be directly opened in Eclipse
and to make it clear it's an editable text file.

Lint was updated to find the Proguard file via the proguard.config
property as well as via the old and new default names for projects not
enabled with ProGuard.

A subsequent CL will add a lint check which identifies projects
containing the old setup (full local configuration) and offer to
replace it with the new setup.

Change-Id: I44b4c97a160114c2382f02f843c95486a0dc9d6b

5 files changed, 103 insertions, 15 deletions

diff --git a/eclipse/plugins/com.android.ide.eclipse.adt/src/com/android/ide/eclipse/adt/internal/build/BuildHelper.java b/eclipse/plugins/com.android.ide.eclipse.adt/src/com/android/ide/eclipse/adt/internal/build/BuildHelper.java
index 3ae9f64..5d2fe78 100644
--- a/eclipse/plugins/com.android.ide.eclipse.adt/src/com/android/ide/eclipse/adt/internal/build/BuildHelper.java
+++ b/eclipse/plugins/com.android.ide.eclipse.adt/src/com/android/ide/eclipse/adt/internal/build/BuildHelper.java
@@ -512,7 +512,7 @@ public class BuildHelper {
         return compiledPaths;
     }
 
-    public void runProguard(File proguardConfig, File inputJar, String[] jarFiles,
+    public void runProguard(List<File> proguardConfigs, File inputJar, String[] jarFiles,
                             File obfuscatedJar, File logOutput)
             throws ProguardResultException, ProguardExecException, IOException {
         IAndroidTarget target = Sdk.getCurrent().getTarget(mProject);
@@ -521,7 +521,10 @@ public class BuildHelper {
         List<String> command = new ArrayList<String>();
         command.add(AdtPlugin.getOsAbsoluteProguard());
 
-        command.add("@" + quotePath(proguardConfig.getAbsolutePath())); //$NON-NLS-1$
+        for (File configFile : proguardConfigs) {
+            command.add("-include"); //$NON-NLS-1$
+            command.add(quotePath(configFile.getAbsolutePath()));
+        }
 
         command.add("-injars"); //$NON-NLS-1$
         StringBuilder sb = new StringBuilder(quotePath(inputJar.getAbsolutePath()));
diff --git a/eclipse/plugins/com.android.ide.eclipse.adt/src/com/android/ide/eclipse/adt/internal/project/ExportHelper.java b/eclipse/plugins/com.android.ide.eclipse.adt/src/com/android/ide/eclipse/adt/internal/project/ExportHelper.java
index 1e5171c..93fe43d 100644
--- a/eclipse/plugins/com.android.ide.eclipse.adt/src/com/android/ide/eclipse/adt/internal/project/ExportHelper.java
+++ b/eclipse/plugins/com.android.ide.eclipse.adt/src/com/android/ide/eclipse/adt/internal/project/ExportHelper.java
@@ -16,6 +16,8 @@
 
 package com.android.ide.eclipse.adt.internal.project;
 
+import static com.android.sdklib.internal.project.ProjectProperties.PROPERTY_SDK;
+
 import com.android.ide.eclipse.adt.AdtConstants;
 import com.android.ide.eclipse.adt.AdtPlugin;
 import com.android.ide.eclipse.adt.AdtUtils;
@@ -25,6 +27,7 @@ import com.android.ide.eclipse.adt.internal.build.DexException;
 import com.android.ide.eclipse.adt.internal.build.NativeLibInJarException;
 import com.android.ide.eclipse.adt.internal.build.ProguardExecException;
 import com.android.ide.eclipse.adt.internal.build.ProguardResultException;
+import com.android.ide.eclipse.adt.internal.preferences.AdtPrefs;
 import com.android.ide.eclipse.adt.internal.sdk.ProjectState;
 import com.android.ide.eclipse.adt.internal.sdk.Sdk;
 import com.android.ide.eclipse.adt.io.IFileWrapper;
@@ -58,6 +61,7 @@ import java.io.IOException;
 import java.io.OutputStream;
 import java.security.PrivateKey;
 import java.security.cert.X509Certificate;
+import java.util.ArrayList;
 import java.util.List;
 import java.util.jar.JarEntry;
 import java.util.jar.JarOutputStream;
@@ -66,8 +70,10 @@ import java.util.jar.JarOutputStream;
  * Export helper to export release version of APKs.
  */
 public final class ExportHelper {
-
-    private final static String TEMP_PREFIX = "android_";  //$NON-NLS-1$
+    private static final String HOME_PROPERTY = "user.home";                    //$NON-NLS-1$
+    private static final String HOME_PROPERTY_REF = "${" + HOME_PROPERTY + '}'; //$NON-NLS-1$
+    private static final String SDK_PROPERTY_REF = "${" + PROPERTY_SDK + '}';   //$NON-NLS-1$
+    private final static String TEMP_PREFIX = "android_";                       //$NON-NLS-1$
 
     /**
      * Exports a release version of the application created by the given project.
@@ -75,7 +81,8 @@ public final class ExportHelper {
      * @param outputFile the file to write
      * @param key the key to used for signing. Can be null.
      * @param certificate the certificate used for signing. Can be null.
-     * @param monitor
+     * @param monitor progress monitor
+     * @throws CoreException if an error occurs
      */
     public static void exportReleaseApk(IProject project, File outputFile, PrivateKey key,
             X509Certificate certificate, IProgressMonitor monitor) throws CoreException {
@@ -151,13 +158,46 @@ public final class ExportHelper {
                     ProjectProperties.PROPERTY_PROGUARD_CONFIG);
 
             boolean runProguard = false;
-            File proguardConfigFile = null;
+            List<File> proguardConfigFiles = null;
             if (proguardConfig != null && proguardConfig.length() > 0) {
-                proguardConfigFile = new File(proguardConfig);
-                if (proguardConfigFile.isAbsolute() == false) {
-                    proguardConfigFile = new File(project.getLocation().toFile(), proguardConfig);
+                // Be tolerant with respect to file and path separators just like
+                // Ant is. Allow "/" in the property file to mean whatever the file
+                // separator character is:
+                if (File.separatorChar != '/' && proguardConfig.indexOf('/') != -1) {
+                    proguardConfig = proguardConfig.replace('/', File.separatorChar);
+                }
+                // Also split path: no need to convert to File.pathSeparator because we'll
+                // be splitting the path ourselves right here, so just ensure that both
+                // ':' and ';' work:
+                if (proguardConfig.indexOf(';') != -1) {
+                    proguardConfig = proguardConfig.replace(';', ':');
+                }
+                String[] paths = proguardConfig.split(":"); //$NON-NLS-1$
+
+                for (String path : paths) {
+                    if (path.startsWith(SDK_PROPERTY_REF)) {
+                        path = AdtPrefs.getPrefs().getOsSdkFolder() +
+                                path.substring(SDK_PROPERTY_REF.length());
+                    } else if (path.startsWith(HOME_PROPERTY_REF)) {
+                        path = System.getProperty(HOME_PROPERTY) +
+                                path.substring(HOME_PROPERTY_REF.length());
+                    }
+                    File proguardConfigFile = new File(path);
+                    if (proguardConfigFile.isAbsolute() == false) {
+                        proguardConfigFile = new File(project.getLocation().toFile(), path);
+                    }
+                    if (proguardConfigFile.isFile()) {
+                        if (proguardConfigFiles == null) {
+                            proguardConfigFiles = new ArrayList<File>();
+                        }
+                        proguardConfigFiles.add(proguardConfigFile);
+                        runProguard = true;
+                    } else {
+                        throw new CoreException(new Status(IStatus.ERROR, AdtPlugin.PLUGIN_ID,
+                                "Invalid proguard configuration file path " + proguardConfigFile
+                                + " does not exist or is not a regular file", null));
+                    }
                 }
-                runProguard = proguardConfigFile.isFile();
             }
 
             String[] dxInput;
@@ -188,7 +228,7 @@ public final class ExportHelper {
                 obfuscatedJar.deleteOnExit();
 
                 // run proguard
-                helper.runProguard(proguardConfigFile, inputJar, jarFiles, obfuscatedJar,
+                helper.runProguard(proguardConfigFiles, inputJar, jarFiles, obfuscatedJar,
                         new File(project.getLocation().toFile(), SdkConstants.FD_PROGUARD));
 
                 // dx input is proguard's output
diff --git a/eclipse/plugins/com.android.ide.eclipse.adt/src/com/android/ide/eclipse/adt/internal/wizards/newproject/NewProjectCreator.java b/eclipse/plugins/com.android.ide.eclipse.adt/src/com/android/ide/eclipse/adt/internal/wizards/newproject/NewProjectCreator.java
index 97da3ab..7424d6c 100644
--- a/eclipse/plugins/com.android.ide.eclipse.adt/src/com/android/ide/eclipse/adt/internal/wizards/newproject/NewProjectCreator.java
+++ b/eclipse/plugins/com.android.ide.eclipse.adt/src/com/android/ide/eclipse/adt/internal/wizards/newproject/NewProjectCreator.java
@@ -606,7 +606,10 @@ public class NewProjectCreator  {
             File libFolder = new File((String) parameters.get(PARAM_SDK_TOOLS_DIR),
                     SdkConstants.FD_LIB);
             addLocalFile(project,
-                    new File(libFolder, SdkConstants.FN_PROGUARD_CFG),
+                    new File(libFolder, SdkConstants.FN_PROJECT_PROGUARD_FILE),
+                    // Write ProGuard config files with the extension .pro which
+                    // is what is used in the ProGuard documentation and samples
+                    SdkConstants.FN_PROJECT_PROGUARD_FILE,
                     monitor);
 
             // Set output location
@@ -1080,13 +1083,14 @@ public class NewProjectCreator  {
     /**
      * Adds a file to the root of the project
      * @param project the project to add the file to.
+     * @param destName the name to write the file as
      * @param source the file to add. It'll keep the same filename once copied into the project.
      * @throws FileNotFoundException
      * @throws CoreException
      */
-    private void addLocalFile(IProject project, File source, IProgressMonitor monitor)
-            throws FileNotFoundException, CoreException {
-        IFile dest = project.getFile(source.getName());
+    private void addLocalFile(IProject project, File source, String destName,
+            IProgressMonitor monitor) throws FileNotFoundException, CoreException {
+        IFile dest = project.getFile(destName);
         if (dest.exists() == false) {
             FileInputStream stream = new FileInputStream(source);
             dest.create(stream, false /* force */, new SubProgressMonitor(monitor, 10));
diff --git a/eclipse/plugins/com.android.ide.eclipse.adt/src/com/android/ide/eclipse/adt/internal/wizards/newproject/NewProjectWizard.java b/eclipse/plugins/com.android.ide.eclipse.adt/src/com/android/ide/eclipse/adt/internal/wizards/newproject/NewProjectWizard.java
index d5bd895..ea78127 100644
--- a/eclipse/plugins/com.android.ide.eclipse.adt/src/com/android/ide/eclipse/adt/internal/wizards/newproject/NewProjectWizard.java
+++ b/eclipse/plugins/com.android.ide.eclipse.adt/src/com/android/ide/eclipse/adt/internal/wizards/newproject/NewProjectWizard.java
@@ -15,6 +15,9 @@
  */
 package com.android.ide.eclipse.adt.internal.wizards.newproject;
 
+import static com.android.sdklib.SdkConstants.FN_PROJECT_PROGUARD_FILE;
+import static com.android.sdklib.SdkConstants.OS_SDK_TOOLS_LIB_FOLDER;
+
 import com.android.ide.eclipse.adt.AdtPlugin;
 import com.android.ide.eclipse.adt.internal.wizards.newproject.NewProjectWizardState.Mode;
 
@@ -26,6 +29,8 @@ import org.eclipse.jface.wizard.Wizard;
 import org.eclipse.ui.INewWizard;
 import org.eclipse.ui.IWorkbench;
 
+import java.io.File;
+
 
 /**
  * A "New Android Project" Wizard.
@@ -105,6 +110,16 @@ public class NewProjectWizard extends Wizard implements INewWizard {
 
     @Override
     public boolean performFinish() {
+        File file = new File(AdtPlugin.getOsSdkFolder(), OS_SDK_TOOLS_LIB_FOLDER + File.separator
+                + FN_PROJECT_PROGUARD_FILE);
+        if (!file.exists()) {
+            AdtPlugin.displayError("Tools Out of Date?",
+            String.format("It looks like you do not have the latest version of the "
+                    + "SDK Tools installed. Make sure you update via the SDK Manager "
+                    + "first. (Could not find %1$s)", file.getPath()));
+            return false;
+        }
+
         NewProjectCreator creator = new NewProjectCreator(mValues, getContainer());
         if (!(creator.createAndroidProjects())) {
             return false;
diff --git a/eclipse/plugins/com.android.ide.eclipse.adt/src/com/android/ide/eclipse/adt/internal/wizards/newproject/ProjectNamePage.java b/eclipse/plugins/com.android.ide.eclipse.adt/src/com/android/ide/eclipse/adt/internal/wizards/newproject/ProjectNamePage.java
index 3db3353..6de6556 100644
--- a/eclipse/plugins/com.android.ide.eclipse.adt/src/com/android/ide/eclipse/adt/internal/wizards/newproject/ProjectNamePage.java
+++ b/eclipse/plugins/com.android.ide.eclipse.adt/src/com/android/ide/eclipse/adt/internal/wizards/newproject/ProjectNamePage.java
@@ -18,8 +18,11 @@ package com.android.ide.eclipse.adt.internal.wizards.newproject;
 import static com.android.ide.eclipse.adt.AdtUtils.capitalize;
 import static com.android.ide.eclipse.adt.AdtUtils.stripWhitespace;
 import static com.android.ide.eclipse.adt.internal.wizards.newproject.ApplicationInfoPage.ACTIVITY_NAME_SUFFIX;
+import static com.android.sdklib.SdkConstants.FN_PROJECT_PROGUARD_FILE;
+import static com.android.sdklib.SdkConstants.OS_SDK_TOOLS_LIB_FOLDER;
 
 import com.android.ide.eclipse.adt.AdtPlugin;
+import com.android.ide.eclipse.adt.internal.VersionCheck;
 import com.android.ide.eclipse.adt.internal.project.AndroidManifestHelper;
 import com.android.ide.eclipse.adt.internal.wizards.newproject.NewProjectWizardState.Mode;
 import com.android.sdklib.SdkConstants;
@@ -85,6 +88,15 @@ class ProjectNamePage extends WizardPage implements SelectionListener, ModifyLis
     private Button mBrowseButton;
     private Label mLocationLabel;
     private WorkingSetGroup mWorkingSetGroup;
+    /**
+     * Whether we've made sure the Tools are up to date (enough that all the
+     * resources required by the New Project wizard are present -- we don't
+     * necessarily check for newer versions than that here; that's done by
+     * {@link VersionCheck}, though that check doesn't <b>enforce</b> an update
+     * since it needs to allow the user to proceed to access the SDK manager
+     * etc.)
+     */
+    private boolean mCheckedSdkUptodate;
 
     /**
      * Create the wizard.
@@ -446,6 +458,20 @@ class ProjectNamePage extends WizardPage implements SelectionListener, ModifyLis
             }
         }
 
+        if (!mCheckedSdkUptodate) {
+            // Ensure that we have a recent enough version of the Tools that the right templates
+            // are available
+            File file = new File(AdtPlugin.getOsSdkFolder(), OS_SDK_TOOLS_LIB_FOLDER
+                    + File.separator + FN_PROJECT_PROGUARD_FILE);
+            if (!file.exists()) {
+                status = new Status(IStatus.ERROR, AdtPlugin.PLUGIN_ID,
+                        String.format("You do not have the latest version of the "
+                        + "SDK Tools installed: Please update. (Missing %1$s)", file.getPath()));
+            } else {
+                mCheckedSdkUptodate = true;
+            }
+        }
+
         // -- update UI & enable finish if there's no error
         setPageComplete(status == null || status.getSeverity() != IStatus.ERROR);
         if (status != null) {