/** Stuff with dependencies. Copyright: © 2012 Matthias Dondorff License: Subject to the terms of the MIT license, as written in the included LICENSE.txt file. Authors: Matthias Dondorff */ module dub.package_; import dub.dependency; import dub.utils; import std.array; import std.conv; import std.exception; import std.file; import vibe.core.file; import vibe.data.json; import vibe.inet.url; enum PackageJsonFilename = "package.json"; struct BuildPlatform { string[] platform; string[] architecture; string compiler; } struct BuildSettings { string[] dflags; string[] lflags; string[] libs; string[] files; string[] copyFiles; string[] versions; string[] importPaths; string[] stringImportPaths; void parse(in Json root, BuildPlatform platform) { addDFlags(getPlatformField(root, "dflags", platform)); addLFlags(getPlatformField(root, "lflags", platform)); addLibs(getPlatformField(root, "libs", platform)); addFiles(getPlatformField(root, "files", platform)); addCopyFiles(getPlatformField(root, "copyFiles", platform)); addVersions(getPlatformField(root, "versions", platform)); addImportDirs(getPlatformField(root, "importPaths", platform)); addStringImportDirs(getPlatformField(root, "stringImportPaths", platform)); } void addDFlags(string[] value) { add(dflags, value); } void addLFlags(string[] value) { add(lflags, value); } void addLibs(string[] value) { add(libs, value); } void addFiles(string[] value) { add(files, value); } void addCopyFiles(string[] value) { add(copyFiles, value); } void addVersions(string[] value) { add(versions, value); } void addImportDirs(string[] value) { add(importPaths, value); } void addStringImportDirs(string[] value) { add(stringImportPaths, value); } private void add(ref string[] arr, string[] vals) { foreach( v; vals ){ bool found = false; foreach( i; 0 .. arr.length ) if( arr[i] == v ){ found = true; break; } if( !found ) arr ~= v; } } private string[] getPlatformField(in Json json, string name, BuildPlatform platform) const { auto ret = appender!(string[])(); foreach( suffix; getPlatformSuffixIterator(platform) ){ foreach( j; json[name~suffix].opt!(Json[]) ) ret.put(j.get!string); } return ret.data; } } int delegate(scope int delegate(ref string)) getPlatformSuffixIterator(BuildPlatform platform) { int iterator(scope int delegate(ref string s) del) { auto c = platform.compiler; int delwrap(string s) { return del(s); } if( auto ret = delwrap(null) ) return ret; if( auto ret = delwrap("-"~c) ) return ret; foreach( p; platform.platform ){ if( auto ret = delwrap("-"~p) ) return ret; if( auto ret = delwrap("-"~p~"-"~c) ) return ret; foreach( a; platform.architecture ){ if( auto ret = delwrap("-"~p~"-"~a) ) return ret; if( auto ret = delwrap("-"~p~"-"~a~"-"~c) ) return ret; } } foreach( a; platform.architecture ){ if( auto ret = delwrap("-"~a) ) return ret; if( auto ret = delwrap("-"~a~"-"~c) ) return ret; } return 0; } return &iterator; } /// Representing an installed package // Json file example: // { // "name": "MetalCollection", // "author": "VariousArtists", // "version": "1.0.0", // "url": "https://github.org/...", // "keywords": "a,b,c", // "category": "music.best", // "dependencies": { // "black-sabbath": ">=1.0.0", // "CowboysFromHell": "<1.0.0", // "BeneathTheRemains": {"version": "0.4.1", "path": "./beneath-0.4.1"} // } // "licenses": { // ... // } // } class Package { static struct LocalPackageDef { string name; Version version_; Path path; } private { InstallLocation m_location; Path m_path; Json m_meta; Dependency[string] m_dependencies; LocalPackageDef[] m_localPackageDefs; } this(InstallLocation location, Path root) { this(jsonFromFile(root ~ PackageJsonFilename), location, root); } this(Json package_info, InstallLocation location = InstallLocation.Local, Path root = Path()) { m_location = location; m_path = root; m_meta = package_info; // extract dependencies and local package definitions if( auto pd = "dependencies" in package_info ){ foreach( string pkg, verspec; *pd ) { enforce(pkg !in m_dependencies, "The dependency '"~pkg~"' is specified more than once." ); if( verspec.type == Json.Type.Object ){ auto ver = verspec["version"].get!string; m_dependencies[pkg] = new Dependency("==", ver); m_localPackageDefs ~= LocalPackageDef(pkg, Version(ver), Path(verspec.path.get!string())); } else m_dependencies[pkg] = new Dependency(verspec.get!string()); } } } @property string name() const { return cast(string)m_meta["name"]; } @property string vers() const { return cast(string)m_meta["version"]; } @property Version ver() const { return Version(m_meta["version"].get!string); } @property installLocation() const { return m_location; } @property Path path() const { return m_path; } @property const(Url) url() const { return Url.parse(cast(string)m_meta["url"]); } @property const(Dependency[string]) dependencies() const { return m_dependencies; } @property const(LocalPackageDef)[] localPackageDefs() const { return m_localPackageDefs; } @property string binaryPath() const { return m_meta["binaryPath"].opt!string; } @property string[] configurations() const { auto pv = "configurations" in m_meta; if( !pv ) return null; auto ret = appender!(string[])(); foreach( string k, _; *pv ) ret.put(k); return ret.data; } BuildSettings getBuildSettings(BuildPlatform platform, string config) const { BuildSettings ret; ret.parse(m_meta, platform); if( config.length ){ auto pcs = "configurations" in m_meta; if( !pcs ) return ret; auto pc = config in *pcs; if( !pc ) return ret; ret.parse(*pc, platform); } return ret; } @property const(Path[]) sources() const { Path[] allSources; foreach(DirEntry d; dirEntries(to!string(m_path ~ Path("source")), "*.d", SpanMode.depth)) allSources ~= Path(d.name); return allSources; } string getDefaultConfiguration(BuildPlatform platform) const { string ret; auto cfgs = m_meta["configurations"].opt!(Json[string]); foreach( suffix; getPlatformSuffixIterator(platform) ) if( auto pv = ("default"~suffix) in cfgs ) ret = pv.get!string(); return ret; } string info() const { string s; s ~= cast(string)m_meta["name"] ~ ", version '" ~ cast(string)m_meta["version"] ~ "'"; s ~= "\n Dependencies:"; foreach(string p, ref const Dependency v; m_dependencies) s ~= "\n " ~ p ~ ", version '" ~ to!string(v) ~ "'"; return s; } /// direct access to the json of this package @property ref Json json() { return m_meta; } /// Writes the json file back to the filesystem void writeJson(Path path) { auto dstFile = openFile((path~PackageJsonFilename).toString(), FileMode.CreateTrunc); scope(exit) dstFile.close(); Appender!string js; toPrettyJson(js, m_meta); dstFile.write( js.data ); } } enum InstallLocation { Local, ProjectLocal, UserWide, SystemWide }