| /* |
| * Copyright (C) 2015 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.android.tools.idea.sdk.remote.internal.packages; |
| |
| import com.android.SdkConstants; |
| import com.android.annotations.NonNull; |
| import com.android.sdklib.AndroidVersion; |
| import com.android.sdklib.SdkManager; |
| import com.android.sdklib.io.IFileOp; |
| import com.android.sdklib.repository.FullRevision; |
| import com.android.sdklib.repository.IDescription; |
| import com.android.sdklib.repository.MajorRevision; |
| import com.android.sdklib.repository.descriptors.PkgDesc; |
| import com.android.tools.idea.sdk.remote.RemotePkgInfo; |
| import com.android.tools.idea.sdk.remote.internal.ITaskMonitor; |
| import com.android.tools.idea.sdk.remote.internal.archives.Archive; |
| import com.android.tools.idea.sdk.remote.internal.sources.SdkRepoConstants; |
| import com.android.tools.idea.sdk.remote.internal.sources.SdkSource; |
| import org.apache.commons.compress.archivers.zip.ZipArchiveEntry; |
| import org.w3c.dom.Node; |
| |
| import java.io.File; |
| import java.util.Map; |
| import java.util.Properties; |
| |
| /** |
| * Represents a source XML node in an SDK repository. |
| */ |
| public class RemoteSourcePkgInfo extends RemotePkgInfo implements IAndroidVersionProvider { |
| |
| /** |
| * Creates a new source package from the attributes and elements of the given XML node. |
| * This constructor should throw an exception if the package cannot be created. |
| * |
| * @param source The {@link SdkSource} where this is loaded from. |
| * @param packageNode The XML element being parsed. |
| * @param nsUri The namespace URI of the originating XML document, to be able to deal with |
| * parameters that vary according to the originating XML schema. |
| * @param licenses The licenses loaded from the XML originating document. |
| */ |
| public RemoteSourcePkgInfo(SdkSource source, Node packageNode, String nsUri, Map<String, String> licenses) { |
| super(source, packageNode, nsUri, licenses); |
| |
| int apiLevel = RemotePackageParserUtils.getXmlInt(packageNode, SdkRepoConstants.NODE_API_LEVEL, 0); |
| String codeName = RemotePackageParserUtils.getXmlString(packageNode, SdkRepoConstants.NODE_CODENAME); |
| if (codeName.length() == 0) { |
| codeName = null; |
| } |
| AndroidVersion version = new AndroidVersion(apiLevel, codeName); |
| |
| PkgDesc.Builder pkgDescBuilder = PkgDesc.Builder.newSource(version, new MajorRevision(getRevision())); |
| pkgDescBuilder.setDescriptionShort(createShortDescription(mListDisplay, getRevision(), version, isObsolete())); |
| pkgDescBuilder.setDescriptionUrl(getDescUrl()); |
| pkgDescBuilder.setListDisplay(createListDescription(mListDisplay, version, isObsolete())); |
| pkgDescBuilder.setIsObsolete(isObsolete()); |
| pkgDescBuilder.setLicense(getLicense()); |
| mPkgDesc = pkgDescBuilder.create(); |
| } |
| |
| /** |
| * Save the properties of the current packages in the given {@link Properties} object. |
| * These properties will later be given to a constructor that takes a {@link Properties} object. |
| */ |
| @Override |
| public void saveProperties(Properties props) { |
| super.saveProperties(props); |
| getPkgDesc().getAndroidVersion().saveProperties(props); |
| } |
| |
| /** |
| * Returns the android version of this package. |
| */ |
| @Override |
| @NonNull |
| public AndroidVersion getAndroidVersion() { |
| return getPkgDesc().getAndroidVersion(); |
| } |
| |
| /** |
| * Returns a string identifier to install this package from the command line. |
| * For sources, we use "source-N" where N is the API or the preview codename. |
| * <p/> |
| * {@inheritDoc} |
| */ |
| @Override |
| public String installId() { |
| return "source-" + getPkgDesc().getAndroidVersion().getApiString(); //$NON-NLS-1$ |
| } |
| |
| /** |
| * Returns a description of this package that is suitable for a list display. |
| * <p/> |
| */ |
| private static String createListDescription(String listDisplay, AndroidVersion version, boolean obsolete) { |
| if (!listDisplay.isEmpty()) { |
| return String.format("%1$s%2$s", listDisplay, obsolete ? " (Obsolete)" : ""); |
| } |
| |
| if (version.isPreview()) { |
| return String.format("Sources for Android '%1$s' Preview SDK%2$s", version.getCodename(), obsolete ? " (Obsolete)" : ""); |
| } |
| else { |
| return String.format("Sources for Android SDK%2$s", version.getApiLevel(), obsolete ? " (Obsolete)" : ""); |
| } |
| } |
| |
| /** |
| * Returns a short description for an {@link IDescription}. |
| */ |
| private static String createShortDescription(String listDisplay, FullRevision revision, AndroidVersion version, boolean obsolete) { |
| if (!listDisplay.isEmpty()) { |
| return String.format("%1$s, revision %2$s%3$s", listDisplay, revision.toShortString(), obsolete ? " (Obsolete)" : ""); |
| } |
| |
| if (version.isPreview()) { |
| return String |
| .format("Sources for Android '%1$s' Preview SDK, revision %2$s%3$s", version.getCodename(), revision.toShortString(), |
| obsolete ? " (Obsolete)" : ""); |
| } |
| else { |
| return String.format("Sources for Android SDK, API %1$d, revision %2$s%3$s", version.getApiLevel(), revision.toShortString(), |
| obsolete ? " (Obsolete)" : ""); |
| } |
| } |
| |
| /** |
| * Computes a potential installation folder if an archive of this package were |
| * to be installed right away in the given SDK root. |
| * <p/> |
| * A sources package is typically installed in SDK/sources/platform. |
| * |
| * @param osSdkRoot The OS path of the SDK root folder. |
| * @param sdkManager An existing SDK manager to list current platforms and addons. |
| * @return A new {@link File} corresponding to the directory to use to install this package. |
| */ |
| @Override |
| public File getInstallFolder(String osSdkRoot, SdkManager sdkManager) { |
| File folder = new File(osSdkRoot, SdkConstants.FD_PKG_SOURCES); |
| folder = new File(folder, "android-" + getPkgDesc().getAndroidVersion().getApiString()); //$NON-NLS-1$ |
| return folder; |
| } |
| |
| /** |
| * Set all the files from a source package as read-only |
| * so that users don't end up modifying sources by mistake in Eclipse. |
| */ |
| @Override |
| public void postUnzipFileHook(Archive archive, ITaskMonitor monitor, IFileOp fileOp, File unzippedFile, ZipArchiveEntry zipEntry) { |
| super.postUnzipFileHook(archive, monitor, fileOp, unzippedFile, zipEntry); |
| |
| if (fileOp.isFile(unzippedFile) && !SdkConstants.FN_SOURCE_PROP.equals(unzippedFile.getName())) { |
| fileOp.setReadOnly(unzippedFile); |
| } |
| } |
| |
| @Override |
| public int hashCode() { |
| final int prime = 31; |
| int result = super.hashCode(); |
| AndroidVersion version = getPkgDesc().getAndroidVersion(); |
| result = prime * result + ((version == null) ? 0 : version.hashCode()); |
| return result; |
| } |
| } |