XmlDependencies.cs

// <copyright file="XmlDependencies.cs" company="Google Inc.">
// Copyright (C) 2017 Google Inc. All Rights Reserved.
//
//  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.
// </copyright>


namespace GooglePlayServices {
    using System;
    using System.Collections.Generic;
    using System.IO;
    using System.Text.RegularExpressions;
    using Google;
    using UnityEditor;

    /// <summary>
    /// Parses XML declared dependencies required by a Unity plugin.
    /// </summary>
    internal class XmlDependencies {

        /// <summary>
        /// Human readable name for dependency files managed by this class.
        /// </summary>
        protected string dependencyType = "dependencies";

        /// <summary>
        /// Determines whether a filename matches an XML dependencies file.
        /// </summary>
        /// <returns>true if it is a match, false otherwise.</returns>
        internal static bool IsDependenciesFile(string filename) {
            if (!filename.EndsWith("Dependencies.xml")) {
                return false;
            }
            // This method was optimized to avoid using regex after profiling results from a large Unity project.
            return filename.Contains("/Editor/") || filename.Contains(@"\Editor\");
        }

        /// <summary>
        /// Find all XML declared dependency files.
        /// </summary>
        /// <returns>List of XML dependency filenames in the project.</returns>
        private List<string> FindFiles() {
            return new List<string>(
                VersionHandlerImpl.SearchAssetDatabase(
                   "Dependencies t:TextAsset", IsDependenciesFile,
                   new [] { "Assets", "Packages"}));
        }

        /// <summary>
        /// Read XML declared dependencies.
        /// </summary>
        /// <param name="filename">File to read.</param>
        /// <param name="logger">Logger class.</param>
        /// <returns>true if the file was read successfully, false otherwise.</returns>
        protected virtual bool Read(string filename, Logger logger) {
            return false;
        }

        /// <summary>
        /// Find and read all XML declared dependencies.
        /// </summary>
        /// <param name="logger">Logger class.</param>
        /// <returns>true if all files were read successfully, false otherwise.</returns>
        public virtual bool ReadAll(Logger logger) {
            bool success = true;
            foreach (var filename in FindFiles()) {
                if (!Read(filename, logger)) {
                    logger.Log(String.Format("Unable to read {0} from {1}.\n" +
                                         "{0} in this file will be ignored.", dependencyType,
                                             filename),
                               level: LogLevel.Error);
                    success = false;
                }
            }
            return success;
        }
    }
}