/**
 * @license
 * Copyright (c) 2015 The Polymer Project Authors. All rights reserved.
 * This code may only be used under the BSD style license found at http://polymer.github.io/LICENSE.txt
 * The complete set of authors may be found at http://polymer.github.io/AUTHORS.txt
 * The complete set of contributors may be found at http://polymer.github.io/CONTRIBUTORS.txt
 * Code distributed by Google as part of the polymer project is also
 * subject to an additional IP rights grant found at http://polymer.github.io/PATENTS.txt
 */

'use strict';

import * as dom5 from 'dom5';
import * as url from 'url';
import * as estree from 'estree';
import * as docs from './ast-utils/docs';
import {FileLoader} from './loader/file-loader';
import {importParse, ParsedImport, LocNode} from './ast-utils/import-parse';
import {jsParse} from './ast-utils/js-parse';
import {Resolver} from './loader/resolver';
import {NoopResolver} from './loader/noop-resolver';
import {StringResolver} from './loader/string-resolver';
import {FSResolver} from './loader/fs-resolver';
import {XHRResolver} from './loader/xhr-resolver';
import {ErrorSwallowingFSResolver} from './loader/error-swallowing-fs-resolver';
import {Descriptor, ElementDescriptor, FeatureDescriptor, BehaviorDescriptor} from './ast-utils/descriptors';

function reduceMetadata(m1:DocumentDescriptor, m2:DocumentDescriptor): DocumentDescriptor {
  return {
    elements:  m1.elements.concat(m2.elements),
    features:  m1.features.concat(m2.features),
    behaviors: m1.behaviors.concat(m2.behaviors),
  };
}

var EMPTY_METADATA: DocumentDescriptor = {elements: [], features: [], behaviors: []};

/**
 * Package of a parsed JS script
 */
interface ParsedJS {
  ast: estree.Program;
  scriptElement: dom5.Node;
}

/**
 * The metadata for all features and elements defined in one document
 */
interface DocumentDescriptor {
  /**
   * The elements from the document.
   */
  elements: ElementDescriptor[];

  /**
   * The features from the document
   */
  features: FeatureDescriptor[];

  /**
   * The behaviors from the document
   */
  behaviors: BehaviorDescriptor[];

  href?: string;

  imports?: DocumentDescriptor[];

  parsedScript?: estree.Program;

  html?: ParsedImport;
}

/**
 * The metadata of an entire HTML document, in promises.
 */
interface AnalyzedDocument {
  /**
   * The url of the document.
   */
  href: string;
  /**
   * The parsed representation of the doc. Use the `ast` property to get
   * the full `parse5` ast.
   */
  htmlLoaded: Promise<ParsedImport>;

  /**
   * Resolves to the list of this Document's transitive import dependencies.
   */
  depsLoaded: Promise<string[]>;

  /**
   * The direct dependencies of the document.
   */
  depHrefs: string[];
  /**
   * Resolves to the list of this Document's import dependencies
   */
  metadataLoaded: Promise<DocumentDescriptor>;
}

/**
 * Options for `Analyzer.analzye`
 */
interface LoadOptions {
  /**
   * Whether `annotate()` should be skipped.
   */
  noAnnotations?: boolean;
  /**
   * Content to resolve `href` to instead of loading from the file system.
   */
  content?: string;
  /**
   * Whether the generated descriptors should be cleaned of redundant data.
   */
  clean?: boolean;
  /**
   * `xhr` to use XMLHttpRequest.
   * `fs` to use the local filesystem.
   * `permissive` to use the local filesystem and return empty files when a
   * path can't be found.
   * Default is `fs` in node and `xhr` in the browser.
   */
  resolver?: string;
  /**
   * A predicate function that indicates which files should be ignored by
   * the loader. By default all files not located under the dirname
   * of `href` will be ignored.
   */
  filter?: (path:string)=> boolean;

  /**
   * If resolver is 'xhr':
   * Type of object to be returned by the XHR. Defaults to 'text',
   * accepts 'document', 'arraybuffer', and 'json'.
   * responseType: string;
   */
  responseType?: string;

  /**
   * If resolver is 'xhr':
   * If true, we'll set the `withCredentials` property on any XHRs made.
   * This is relevant for whether cross-domain requests include cookies.
   */
  withCredentials?: boolean;
}

/**
 * An Error extended with location metadata.
 */
interface LocError extends Error{
  location: {line: number; column: number};
  ownerDocument: string;
}

/**
 * A database of Polymer metadata defined in HTML
 */
export class Analyzer {
  loader: FileLoader;
  /**
   * A list of all elements the `Analyzer` has metadata for.
   */
  elements: ElementDescriptor[] = [];
  /**
   * A view into `elements`, keyed by tag name.
   */
  elementsByTagName: {[tagName: string]: ElementDescriptor} = {};

  /**
   * A list of API features added to `Polymer.Base` encountered by the
   * analyzer.
   */
  features: FeatureDescriptor[] = [];

  /**
   * The behaviors collected by the analysis pass.
   */
  behaviors: BehaviorDescriptor[] = [];
  /**
   * The behaviors collected by the analysis pass by name.
   */
  behaviorsByName: {[name:string]: BehaviorDescriptor} = {};

  /**
   * A map, keyed by absolute path, of Document metadata.
   */
  html: {[path: string]: AnalyzedDocument} = {};

  /**
   * A map, keyed by path, of HTML document ASTs.
   */
  parsedDocuments: {[path:string]: dom5.Node} = {};

  /**
   * A map, keyed by path, of JS script ASTs.
   *
   * If the path is an HTML file with multiple scripts,
   * the entry will be an array of scripts.
   */
  parsedScripts: {[path:string]: ParsedJS[]} = {};


  /**
   * A map, keyed by path, of document content.
   */
  _content: {[path:string]: string} = {};

  /**
   * @param  {boolean} attachAST  If true, attach a parse5 compliant AST
   * @param  {FileLoader=} loader An optional `FileLoader` used to load external
   *                              resources
   */
  constructor(attachAST:boolean, loader:FileLoader) {
    this.loader = loader;
  }

  /**
   * Shorthand for transitively loading and processing all imports beginning at
   * `href`.
   *
   * In order to properly filter paths, `href` _must_ be an absolute URI.
   *
   * @param {string} href The root import to begin loading from.
   * @param {LoadOptions=} options Any additional options for the load.
   * @return {Promise<Analyzer>} A promise that will resolve once `href` and its
   *     dependencies have been loaded and analyzed.
   */
  static analyze = function analyze(href:string, options?:LoadOptions) {
    options = options || {};
    options.filter = options.filter || _defaultFilter(href);

    var loader = new FileLoader();

    var resolver = options.resolver;
    if (resolver === undefined) {
      if (typeof window === 'undefined') {
        resolver = 'fs';
      } else {
        resolver = 'xhr';
      }
    }
    let primaryResolver: Resolver;
    if (resolver === 'fs') {
      primaryResolver = new FSResolver(options);
    } else if (resolver === 'xhr') {
      primaryResolver = new XHRResolver(options);
    } else if (resolver === 'permissive') {
      primaryResolver = new ErrorSwallowingFSResolver(options);
    } else {
      throw new Error("Resolver must be one of 'fs', 'xhr', or 'permissive'");
    }

    loader.addResolver(primaryResolver);
    if (options.content) {
      loader.addResolver(new StringResolver({url: href, content: options.content}));
    }
    loader.addResolver(new NoopResolver({test: options.filter}));

    var analyzer = new Analyzer(false, loader);
    return analyzer.metadataTree(href).then((root) => {
      if (!options.noAnnotations) {
        analyzer.annotate();
      }
      if (options.clean) {
        analyzer.clean();
      }
      return Promise.resolve(analyzer);
    });
  };

  load(href: string):Promise<AnalyzedDocument> {
    return this.loader.request(href).then((content) => {
      return new Promise<AnalyzedDocument>((resolve, reject) => {
        setTimeout(() => {
          this._content[href] = content;
          resolve(this._parseHTML(content, href));
        }, 0);
      }).catch(function(err){
        console.error("Error processing document at " + href);
        throw err;
      });
    });
  };

  /**
   * Returns an `AnalyzedDocument` representing the provided document
   * @private
   * @param  {string} htmlImport Raw text of an HTML document
   * @param  {string} href       The document's URL.
   * @return {AnalyzedDocument}       An  `AnalyzedDocument`
   */
  _parseHTML(htmlImport: string, href: string):AnalyzedDocument {
    if (href in this.html) {
      return this.html[href];
    }
    var depsLoaded: Promise<Object>[] = [];
    var depHrefs: string[] = [];
    var metadataLoaded = Promise.resolve(EMPTY_METADATA);
    var parsed: ParsedImport;
    try {
      parsed = importParse(htmlImport, href);
    } catch (err) {
      console.error('Error parsing!');
      throw err;
    }
    var htmlLoaded = Promise.resolve(parsed);
    if (parsed.script) {
      metadataLoaded = this._processScripts(parsed.script, href);
    }
    var commentText = parsed.comment.map(function(comment){
      return dom5.getTextContent(comment);
    });
    var pseudoElements = docs.parsePseudoElements(commentText);
    for (const element of pseudoElements) {
      element.contentHref = href;
      this.elements.push(element);
      if (element.is) {
        this.elementsByTagName[element.is] = element;
      }
    }
    metadataLoaded = metadataLoaded.then(function(metadata){
      var metadataEntry: DocumentDescriptor = {
        elements: pseudoElements,
        features: [],
        behaviors: []
      };
      return [metadata, metadataEntry].reduce(reduceMetadata);
    });
    depsLoaded.push(metadataLoaded);


    if (this.loader) {
      var baseUri = href;
      if (parsed.base.length > 1) {
        console.error("Only one base tag per document!");
        throw "Multiple base tags in " + href;
      } else if (parsed.base.length == 1) {
        var baseHref = dom5.getAttribute(parsed.base[0], "href");
        if (baseHref) {
          baseHref = baseHref + "/";
          baseUri = url.resolve(baseUri, baseHref);
        }
      }
      for (const link of parsed.import) {
        var linkurl = dom5.getAttribute(link, 'href');
        if (linkurl) {
          var resolvedUrl = url.resolve(baseUri, linkurl);
          depHrefs.push(resolvedUrl);
          depsLoaded.push(this._dependenciesLoadedFor(resolvedUrl, href));
        }
      }
      for (const styleElement of parsed.style) {
        if (polymerExternalStyle(styleElement)) {
          var styleHref = dom5.getAttribute(styleElement, 'href');
          if (href) {
            styleHref = url.resolve(baseUri, styleHref);
            depsLoaded.push(this.loader.request(styleHref).then((content) => {
              this._content[styleHref] = content;
              return {};
            }));
          }
        }
      }
    }
    const depsStrLoaded = Promise.all(depsLoaded)
          .then(function() {return depHrefs;})
          .catch(function(err) {throw err;});
    this.parsedDocuments[href] = parsed.ast;
    this.html[href] = {
        href: href,
        htmlLoaded: htmlLoaded,
        metadataLoaded: metadataLoaded,
        depHrefs: depHrefs,
        depsLoaded: depsStrLoaded
    };
    return this.html[href];
  };

  _processScripts(scripts: LocNode[], href: string) {
    var scriptPromises: Promise<DocumentDescriptor>[] = [];
    scripts.forEach((script) => {
      scriptPromises.push(this._processScript(script, href));
    });
    return Promise.all(scriptPromises).then(function(metadataList) {
      // TODO(ajo) remove this cast.
      var list: DocumentDescriptor[] = <any>metadataList;
      return list.reduce(reduceMetadata, EMPTY_METADATA);
    });
  };

  _processScript(script: LocNode, href: string):Promise<DocumentDescriptor> {
    const src = dom5.getAttribute(script, 'src');
    var parsedJs: DocumentDescriptor;
    if (!src) {
      try {
        parsedJs = jsParse((script.childNodes.length) ? script.childNodes[0].value : '');
      } catch (err) {
        // Figure out the correct line number for the error.
        var line = 0;
        var col = 0;
        if (script.__ownerDocument && script.__ownerDocument == href) {
          line = script.__locationDetail.line - 1;
          col = script.__locationDetail.column - 1;
        }
        line += err.lineNumber;
        col += err.column;
        var message = "Error parsing script in " + href + " at " + line + ":" + col;
        message += "\n" + err.stack;
        var fixedErr = <LocError>(new Error(message));
        fixedErr.location = {line: line, column: col};
        fixedErr.ownerDocument = script.__ownerDocument;
        return Promise.reject<DocumentDescriptor>(fixedErr);
      }
      if (parsedJs.elements) {
        parsedJs.elements.forEach((element) => {
          element.scriptElement = script;
          element.contentHref = href;
          this.elements.push(element);
          if (element.is in this.elementsByTagName) {
            console.warn('Ignoring duplicate element definition: ' + element.is);
          } else if (element.is) {
            this.elementsByTagName[element.is] = element;
          }
        });
      }
      if (parsedJs.features) {
        parsedJs.features.forEach(function(feature){
          feature.contentHref = href;
          feature.scriptElement = script;
        });
        this.features = this.features.concat(parsedJs.features);
      }
      if (parsedJs.behaviors) {
        parsedJs.behaviors.forEach((behavior) => {
          behavior.contentHref = href;
          this.behaviorsByName[behavior.is] = behavior;
          this.behaviorsByName[behavior.symbol] = behavior;
        });
        this.behaviors = this.behaviors.concat(parsedJs.behaviors);
      }
      if (!Object.hasOwnProperty.call(this.parsedScripts, href)) {
        this.parsedScripts[href] = [];
      }
      var scriptElement : LocNode;
      if (script.__ownerDocument && script.__ownerDocument == href) {
        scriptElement = script;
      }
      this.parsedScripts[href].push({
        ast: parsedJs.parsedScript,
        scriptElement: scriptElement
      });
      return Promise.resolve(parsedJs);
    }
    if (this.loader) {
      var resolvedSrc = url.resolve(href, src);
      return this.loader.request(resolvedSrc).then((content) => {
        this._content[resolvedSrc] = content;
        var scriptText = dom5.constructors.text(content);
        dom5.append(script, scriptText);
        dom5.removeAttribute(script, 'src');
        script.__hydrolysisInlined = src;
        return this._processScript(script, resolvedSrc);
      }).catch(function(err) {throw err;});
    } else {
      return Promise.resolve(EMPTY_METADATA);
    }
  };

  _dependenciesLoadedFor(href: string, root: string) {
    var found: {[href: string]: boolean} = {};
    if (root !== undefined) {
      found[root] = true;
    }
    return this._getDependencies(href, found).then((deps) => {
      var depPromises = deps.map((depHref) =>{
        return this.load(depHref).then((htmlMonomer) => {
          return htmlMonomer.metadataLoaded;
        });
      });
      return Promise.all(depPromises);
    });
  };

  /**
   * List all the html dependencies for the document at `href`.
   * @param  {string}                   href      The href to get dependencies for.
   * @param  {Object.<string,boolean>=} found     An object keyed by URL of the
   *     already resolved dependencies.
   * @param  {boolean=}                transitive Whether to load transitive
   *     dependencies. Defaults to true.
   * @return {Array.<string>}  A list of all the html dependencies.
   */
  _getDependencies(href:string, found?:{[url:string]: boolean}, transitive?:boolean):Promise<string[]> {
    if (found === undefined) {
      found = {};
      found[href] = true;
    }
    if (transitive === undefined) {
      transitive = true;
    }
    var deps: string[] = [];
    return this.load(href).then((htmlMonomer) => {
      var transitiveDeps: Promise<string[]>[] = [];
      htmlMonomer.depHrefs.forEach((depHref) => {
        if (found[depHref]) {
          return;
        }
        deps.push(depHref);
        found[depHref] = true;
        if (transitive) {
          transitiveDeps.push(this._getDependencies(depHref, found));
        }
      });
      return Promise.all(transitiveDeps);
    }).then(function(transitiveDeps) {
      var alldeps = transitiveDeps.reduce(function(a, b) {
        return a.concat(b);
      }, []).concat(deps);
      return alldeps;
    });
  };

  /**
   * Returns the elements defined in the folder containing `href`.
   * @param {string} href path to search.
   */
  elementsForFolder(href: string): ElementDescriptor[] {
    return this.elements.filter(function(element){
      return matchesDocumentFolder(element, href);
    });
  };

  /**
   * Returns the behaviors defined in the folder containing `href`.
   * @param {string} href path to search.
   * @return {Array.<BehaviorDescriptor>}
   */
  behaviorsForFolder(href:string):BehaviorDescriptor[] {
    return this.behaviors.filter(function(behavior){
      return matchesDocumentFolder(behavior, href);
    });
  };

  /**
   * Returns a promise that resolves to a POJO representation of the import
   * tree, in a format that maintains the ordering of the HTML imports spec.
   * @param {string} href the import to get metadata for.
   * @return {Promise}
   */
  metadataTree(href:string) {
    return this.load(href).then((monomer) =>{
      var loadedHrefs: {[href: string]: boolean} = {};
      loadedHrefs[href] = true;
      return this._metadataTree(monomer, loadedHrefs);
    });
  };

  async _metadataTree(htmlMonomer:AnalyzedDocument, loadedHrefs: {[href: string]: boolean}) {
    if (loadedHrefs === undefined) {
      loadedHrefs = {};
    }
    let metadata = await htmlMonomer.metadataLoaded;
    metadata = {
      elements: metadata.elements,
      features: metadata.features,
      behaviors: [],
      href: htmlMonomer.href
    };
    const hrefs = await htmlMonomer.depsLoaded
    var depMetadata: Promise<DocumentDescriptor>[] = [];
    for (const href of hrefs) {
      let metadataPromise: Promise<DocumentDescriptor>;
      if (!loadedHrefs[href]) {
        loadedHrefs[href] = true;
        metadataPromise = this._metadataTree(this.html[href], loadedHrefs);
        await metadataPromise;
      } else {
        metadataPromise = Promise.resolve({});
      }
      depMetadata.push(metadataPromise);
    }
    return Promise.all(depMetadata).then(function(importMetadata) {
      // TODO(ajo): remove this when tsc stops having issues.
      metadata.imports = <any>importMetadata;
      return htmlMonomer.htmlLoaded.then(function(parsedHtml) {
        metadata.html = parsedHtml;
        if (metadata.elements) {
          metadata.elements.forEach(function(element) {
            attachDomModule(parsedHtml, element);
          });
        }
        return metadata;
      });
    });
  };


  _inlineStyles(ast:dom5.Node, href: string) {
    var cssLinks = dom5.queryAll(ast, polymerExternalStyle);
    cssLinks.forEach((link) => {
      var linkHref = dom5.getAttribute(link, 'href');
      var uri = url.resolve(href, linkHref);
      var content = this._content[uri];
      var style = dom5.constructors.element('style');
      dom5.setTextContent(style, '\n' + content + '\n');
      dom5.replace(link, style);
    });
    return cssLinks.length > 0;
  };

  _inlineScripts(ast: dom5.Node, href: string) {
    var scripts = dom5.queryAll(ast, externalScript);
    scripts.forEach((script) => {
      var scriptHref = dom5.getAttribute(script, 'src');
      var uri = url.resolve(href, scriptHref);
      var content = this._content[uri];
      var inlined = dom5.constructors.element('script');
      dom5.setTextContent(inlined, '\n' + content + '\n');
      dom5.replace(script, inlined);
    });
    return scripts.length > 0;
  };

  _inlineImports(ast:dom5.Node, href:string, loaded:{[href:string]:boolean}) {
    var imports = dom5.queryAll(ast, isHtmlImportNode);
    imports.forEach((htmlImport) => {
      var importHref = dom5.getAttribute(htmlImport, 'href');
      var uri = url.resolve(href, importHref);
      if (loaded[uri]) {
        dom5.remove(htmlImport);
        return;
      }
      var content = this.getLoadedAst(uri, loaded);
      dom5.replace(htmlImport, content);
    });
    return imports.length > 0;
  };

  /**
   * Returns a promise resolving to a form of the AST with all links replaced
   * with the document they link to. .css and .script files become &lt;style&gt; and
   * &lt;script&gt;, respectively.
   *
   * The elements in the loaded document are unmodified from their original
   * documents.
   *
   * @param {string} href The document to load.
   * @param {Object.<string,boolean>=} loaded An object keyed by already loaded documents.
   * @return {Promise.<DocumentAST>}
   */
  getLoadedAst(href:string, loaded:{[href:string]:boolean}) {
    if (!loaded) {
      loaded = {};
    }
    loaded[href] = true;
    var parsedDocument = this.parsedDocuments[href];
    var analyzedDocument = this.html[href];
    var astCopy = dom5.parse(dom5.serialize(parsedDocument));
    // Whenever we inline something, reset inlined to true to know that anoather
    // inlining pass is needed;
    this._inlineStyles(astCopy, href);
    this._inlineScripts(astCopy, href);
    this._inlineImports(astCopy, href, loaded);
    return astCopy;
  };

  /**
   * Calls `dom5.nodeWalkAll` on each document that `Anayzler` has laoded.
   */
  nodeWalkDocuments(predicate:dom5.Predicate) {
    var results: dom5.Node[] = [];
    for (var href in this.parsedDocuments) {
      var newNodes = dom5.nodeWalkAll(this.parsedDocuments[href], predicate);
      results = results.concat(newNodes);
    }
    return results;
  };

  /**
   * Calls `dom5.nodeWalkAll` on each document that `Anayzler` has laoded.
   *
   * TODO: make nodeWalkAll & nodeWalkAllDocuments distict, or delete one.
   */
  nodeWalkAllDocuments(predicate:dom5.Predicate) {
    var results: dom5.Node[] = [];
    for (var href in this.parsedDocuments) {
      var newNodes = dom5.nodeWalkAll(this.parsedDocuments[href], predicate);
      results = results.concat(newNodes);
    }
    return results;
  };


  /** Annotates all loaded metadata with its documentation. */
  annotate() {
    if (this.features.length > 0) {
      var featureEl = docs.featureElement(this.features);
      this.elements.unshift(featureEl);
      if (featureEl.is) {
        this.elementsByTagName[featureEl.is] = featureEl;
      }
    }
    var behaviorsByName = this.behaviorsByName;
    var elementHelper = (descriptor: ElementDescriptor) => {
      docs.annotateElement(descriptor, behaviorsByName);
    };
    this.elements.forEach(elementHelper);
    this.behaviors.forEach(elementHelper); // Same shape.
    this.behaviors.forEach((behavior) =>{
      if (behavior.is !== behavior.symbol && behavior.symbol) {
        this.behaviorsByName[behavior.symbol] = undefined;
      }
    });
  };

  /** Removes redundant properties from the collected descriptors. */
  clean() {
    this.elements.forEach(docs.cleanElement);
  };
};



/**
 * @private
 * @param {string} href
 * @return {function(string): boolean}
 */
function _defaultFilter(href:string) {
  // Everything up to the last `/` or `\`.
  var base = href.match(/^(.*?)[^\/\\]*$/)[1];
  return function(uri:string) {
    return uri.indexOf(base) !== 0;
  };
}

function matchesDocumentFolder(descriptor: ElementDescriptor, href: string) {
  if (!descriptor.contentHref) {
    return false;
  }
  var descriptorDoc = url.parse(descriptor.contentHref);
  if (!descriptorDoc || !descriptorDoc.pathname) {
    return false;
  }
  var searchDoc = url.parse(href);
  if (!searchDoc || !searchDoc.pathname) {
    return false;
  }
  var searchPath = searchDoc.pathname;
  var lastSlash = searchPath.lastIndexOf("/");
  if (lastSlash > 0) {
    searchPath = searchPath.slice(0, lastSlash);
  }
  return descriptorDoc.pathname.indexOf(searchPath) === 0;
}

// TODO(ajo): Refactor out of vulcanize into dom5.
var polymerExternalStyle = dom5.predicates.AND(
  dom5.predicates.hasTagName('link'),
  dom5.predicates.hasAttrValue('rel', 'import'),
  dom5.predicates.hasAttrValue('type', 'css')
);

var externalScript = dom5.predicates.AND(
  dom5.predicates.hasTagName('script'),
  dom5.predicates.hasAttr('src')
);

var isHtmlImportNode = dom5.predicates.AND(
  dom5.predicates.hasTagName('link'),
  dom5.predicates.hasAttrValue('rel', 'import'),
  dom5.predicates.NOT(
    dom5.predicates.hasAttrValue('type', 'css')
  )
);

function attachDomModule(parsedImport: ParsedImport, element: ElementDescriptor) {
  var domModules = parsedImport['dom-module'];
  for (const domModule of domModules) {
    if (dom5.getAttribute(domModule, 'id') === element.is) {
      element.domModule = domModule;
      return;
    }
  }
}