OLD | NEW |
(Empty) | |
| 1 // Copyright (c) 2014, the Dart project authors. Please see the AUTHORS file |
| 2 // for details. All rights reserved. Use of this source code is governed by a |
| 3 // BSD-style license that can be found in the LICENSE file. |
| 4 |
| 5 /// Common methods used by transfomers for dealing with asset IDs. |
| 6 library code_transformers.assets; |
| 7 |
| 8 import 'dart:math' show min, max; |
| 9 |
| 10 import 'package:barback/barback.dart'; |
| 11 import 'package:path/path.dart' as path; |
| 12 import 'package:source_span/source_span.dart'; |
| 13 |
| 14 import 'messages/build_logger.dart'; |
| 15 import 'src/messages.dart'; |
| 16 |
| 17 /// Create an [AssetId] for a [url] seen in the [source] asset. |
| 18 /// |
| 19 /// By default this is used to resolve relative urls that occur in HTML assets, |
| 20 /// including cross-package urls of the form "packages/foo/bar.html". Dart |
| 21 /// "package:" urls are not resolved unless [source] is Dart file (has a .dart |
| 22 /// extension). |
| 23 /// |
| 24 /// This function returns null if [url] can't be resolved. We log a warning |
| 25 /// message in [logger] if we know the reason why resolution failed. This |
| 26 /// happens, for example, when using incorrect paths to reach into another |
| 27 /// package, or when [errorsOnAbsolute] is true and the url seems to be |
| 28 /// absolute. |
| 29 // TODO(sigmund): delete once this is part of barback (dartbug.com/12610) |
| 30 AssetId uriToAssetId(AssetId source, String url, TransformLogger logger, |
| 31 SourceSpan span, {bool errorOnAbsolute: true}) { |
| 32 if (url == null || url == '') return null; |
| 33 var uri = Uri.parse(url); |
| 34 var urlBuilder = path.url; |
| 35 if (uri.host != '' || uri.scheme != '' || urlBuilder.isAbsolute(url)) { |
| 36 if (source.extension == '.dart' && uri.scheme == 'package') { |
| 37 var index = uri.path.indexOf('/'); |
| 38 if (index != -1) { |
| 39 return new AssetId(uri.path.substring(0, index), |
| 40 'lib${uri.path.substring(index)}'); |
| 41 } |
| 42 } |
| 43 |
| 44 if (errorOnAbsolute) { |
| 45 var msg = NO_ABSOLUTE_PATHS.create({'url': url}); |
| 46 logger.warning(logger is BuildLogger ? msg : msg.snippet, span: span); |
| 47 } |
| 48 return null; |
| 49 } |
| 50 |
| 51 var targetPath = urlBuilder.normalize( |
| 52 urlBuilder.join(urlBuilder.dirname(source.path), url)); |
| 53 var segments = urlBuilder.split(targetPath); |
| 54 var sourceSegments = urlBuilder.split(source.path); |
| 55 assert (sourceSegments.length > 0); |
| 56 var topFolder = sourceSegments[0]; |
| 57 var entryFolder = topFolder != 'lib' && topFolder != 'asset'; |
| 58 |
| 59 // Find the first 'packages/' or 'assets/' segment: |
| 60 var packagesIndex = segments.indexOf('packages'); |
| 61 var assetsIndex = segments.indexOf('assets'); |
| 62 var index = (packagesIndex >= 0 && assetsIndex >= 0) |
| 63 ? min(packagesIndex, assetsIndex) |
| 64 : max(packagesIndex, assetsIndex); |
| 65 if (index > -1) { |
| 66 if (entryFolder) { |
| 67 // URLs of the form "packages/foo/bar" seen under entry folders (like |
| 68 // web/, test/, example/, etc) are resolved as an asset in another |
| 69 // package. 'packages' can be used anywhere, there is no need to walk up |
| 70 // where the entrypoint file was. |
| 71 // TODO(sigmund): this needs to change: Only resolve when index == 1 && |
| 72 // topFolder == segment[0], otherwise give a warning (dartbug.com/17596). |
| 73 return _extractOtherPackageId(index, segments, logger, span); |
| 74 } else if (index == 1 && segments[0] == '..') { |
| 75 // Relative URLs of the form "../../packages/foo/bar" in an asset under |
| 76 // lib/ or asset/ are also resolved as an asset in another package, but we |
| 77 // check that the relative path goes all the way out where the packages |
| 78 // folder lives (otherwise the app would not work in Dartium). Since |
| 79 // [targetPath] has been normalized, "packages" or "assets" should be at |
| 80 // index 1. |
| 81 return _extractOtherPackageId(1, segments, logger, span); |
| 82 } else { |
| 83 var prefix = segments[index]; |
| 84 var fixedSegments = []; |
| 85 fixedSegments.addAll(sourceSegments.map((_) => '..')); |
| 86 fixedSegments.addAll(segments.sublist(index)); |
| 87 var fixedUrl = urlBuilder.joinAll(fixedSegments); |
| 88 var msg = INVALID_URL_TO_OTHER_PACKAGE.create( |
| 89 {'url': url, 'prefix': prefix, 'fixedUrl': fixedUrl}); |
| 90 logger.warning(logger is BuildLogger ? msg : msg.snippet, span: span); |
| 91 return null; |
| 92 } |
| 93 } |
| 94 |
| 95 // Otherwise, resolve as a path in the same package. |
| 96 return new AssetId(source.package, targetPath); |
| 97 } |
| 98 |
| 99 AssetId _extractOtherPackageId(int index, List segments, |
| 100 TransformLogger logger, SourceSpan span) { |
| 101 if (index >= segments.length) return null; |
| 102 var prefix = segments[index]; |
| 103 if (prefix != 'packages' && prefix != 'assets') return null; |
| 104 var folder = prefix == 'packages' ? 'lib' : 'asset'; |
| 105 if (segments.length < index + 3) { |
| 106 var msg = INVALID_PREFIX_PATH.create({'prefix': prefix, 'folder': folder}); |
| 107 logger.warning(logger is BuildLogger ? msg : msg.snippet, span: span); |
| 108 return null; |
| 109 } |
| 110 return new AssetId(segments[index + 1], |
| 111 path.url.join(folder, path.url.joinAll(segments.sublist(index + 2)))); |
| 112 } |
OLD | NEW |