Publish Vulpes Preview 15 sources for desktop, Android and Tundra
Share Gaia assets and adapters, keep private profiles and development documents local, and update both public READMEs.
This commit is contained in:
OverSu
parent
93e3a48004
commit
b38dea0597
25901 changed files with 9982925 additions and 369 deletions
406
gaia/build/webapp-shared.js
Executable file
406
gaia/build/webapp-shared.js
Executable file
|
|
@ -0,0 +1,406 @@
|
|||
'use strict';
|
||||
|
||||
/**
|
||||
* Copy shared files to stage folders
|
||||
*/
|
||||
|
||||
var utils = require('./utils');
|
||||
|
||||
var WebappShared = function() {
|
||||
};
|
||||
|
||||
WebappShared.prototype.setOptions = function(options) {
|
||||
this.config = options.config;
|
||||
this.gaia = options.gaia;
|
||||
this.webapp = options.webapp;
|
||||
this.used = {
|
||||
js: [], // List of JS file paths to copy
|
||||
locales: [], // List of locale names to copy
|
||||
resources: [], // List of resources to copy
|
||||
styles: [], // List of stable style names to copy
|
||||
unstable_styles: [], // List of unstable style names to copy
|
||||
elements: [], // List of elements names to copy,
|
||||
pages: [] // List of pages to copy
|
||||
};
|
||||
this.localesFile = utils.resolve(this.config.LOCALES_FILE,
|
||||
this.config.GAIA_DIR);
|
||||
if (!this.localesFile.exists()) {
|
||||
throw new Error('LOCALES_FILE doesn\'t exists: ' + this.localesFile.path);
|
||||
}
|
||||
|
||||
this.buildDir = utils.getFile(this.webapp.buildDirectoryFilePath);
|
||||
};
|
||||
|
||||
WebappShared.prototype.moveToBuildDir = function(file, targetPath) {
|
||||
if (file.isHidden()) {
|
||||
return;
|
||||
}
|
||||
var path = file.path;
|
||||
|
||||
if (!file.exists()) {
|
||||
throw new Error('Can\'t add inexistent file to : ' + path);
|
||||
}
|
||||
|
||||
if (utils.getOsType().indexOf('WIN') !== -1) {
|
||||
targetPath = targetPath.replace(/\//g, '\\\\');
|
||||
}
|
||||
|
||||
var fullTargetPath = utils.joinPath(this.buildDir.path, targetPath);
|
||||
// Case 1/ Regular file
|
||||
if (file.isFile()) {
|
||||
try {
|
||||
utils.copyFileTo(file, utils.dirname(fullTargetPath),
|
||||
utils.basename(fullTargetPath));
|
||||
} catch (e) {
|
||||
throw new Error('Unable to add following file in stage: ' +
|
||||
path + '\n' + e);
|
||||
}
|
||||
}
|
||||
// Case 2/ Directory
|
||||
else if (file.isDirectory()) {
|
||||
utils.copyDirTo(file, utils.dirname(fullTargetPath),
|
||||
utils.basename(fullTargetPath));
|
||||
}
|
||||
};
|
||||
|
||||
/**
|
||||
* Copy a "Building Block" (i.e. shared style resource)
|
||||
*
|
||||
* @param {String} blockName name of the building block to copy.
|
||||
* @param {String} dirName name of the shared directory to use.
|
||||
*/
|
||||
WebappShared.prototype.copyBuildingBlock =
|
||||
function(subDirPath, dirName) {
|
||||
var fullPath = dirName + '/' + subDirPath;
|
||||
var paths = fullPath.split('/');
|
||||
var blockName = paths.pop();
|
||||
var dirPath = 'shared/' + paths.join('/');
|
||||
|
||||
// Compute the nsIFile for this shared style
|
||||
var styleFolder = utils.getFile(this.gaia.sharedFolder.path,
|
||||
paths.join('/'));
|
||||
if (!styleFolder.exists()) {
|
||||
throw new Error('Using inexistent shared style: ' + blockName);
|
||||
}
|
||||
|
||||
var cssFile = utils.getFile(styleFolder.path, blockName + '.css');
|
||||
var pathInStage = dirPath + '/' + blockName + '.css';
|
||||
this.moveToBuildDir(cssFile, pathInStage);
|
||||
|
||||
// Copy everything but index.html and any other HTML page into the
|
||||
// style/<block> folder.
|
||||
var subFolder = utils.getFile(styleFolder.path, blockName);
|
||||
utils.ls(subFolder, true).forEach(function(file) {
|
||||
var relativePath = utils.relativePath(styleFolder.path, file.path);
|
||||
// Ignore HTML files at style root folder
|
||||
if (relativePath.match(/^[^\/]+\.html$/)) {
|
||||
return;
|
||||
}
|
||||
// Do not process directory as `addToZip` will add files recursively
|
||||
if (file.isDirectory()) {
|
||||
return;
|
||||
}
|
||||
this.moveToBuildDir(file, dirPath + '/' + relativePath);
|
||||
}.bind(this));
|
||||
};
|
||||
|
||||
WebappShared.prototype.pushJS = function(path) {
|
||||
var file = utils.getFile(this.gaia.sharedFolder.path, 'js', path);
|
||||
if (!file.exists()) {
|
||||
throw new Error('Using inexistent shared JS file: ' + path + ' from: ' +
|
||||
this.webapp.domain);
|
||||
}
|
||||
var pathInStage = 'shared/js/' + path;
|
||||
this.moveToBuildDir(file, pathInStage);
|
||||
};
|
||||
|
||||
WebappShared.prototype.copyPage = function(path) {
|
||||
var file = utils.getFile(this.gaia.sharedFolder.path, 'pages', path);
|
||||
|
||||
if (!file.exists()) {
|
||||
throw new Error('Using inexistent shared page file: ' + path +
|
||||
' from: ' + this.webapp.domain);
|
||||
}
|
||||
|
||||
var pathInStage = 'shared/pages/' + path;
|
||||
this.moveToBuildDir(file, pathInStage);
|
||||
|
||||
let extension = utils.getExtension(file.leafName);
|
||||
// If it is an HTML file we need to check for the referenced shared
|
||||
// resources
|
||||
if (extension === 'html') {
|
||||
this.filterSharedUsage(file);
|
||||
}
|
||||
};
|
||||
|
||||
WebappShared.prototype.pushResource = function(path) {
|
||||
var paths = utils.joinPath(this.gaia.sharedFolder.path, 'resources');
|
||||
path.split('/').forEach(function(segment) {
|
||||
paths = utils.joinPath(paths, segment);
|
||||
if (utils.isSubjectToBranding(paths)) {
|
||||
paths = utils.joinPath(paths,
|
||||
(this.config.OFFICIAL === '1' ? 'official' : 'unofficial'));
|
||||
}
|
||||
if (utils.isSubjectToDeviceType(paths)) {
|
||||
paths = utils.joinPath(paths, this.config.GAIA_DEVICE_TYPE);
|
||||
}
|
||||
}.bind(this));
|
||||
var file = utils.getFile(paths);
|
||||
if (!file.exists()) {
|
||||
throw new Error('Using inexistent shared resource: ' + path +
|
||||
' from: ' + this.webapp.domain + '\n');
|
||||
}
|
||||
|
||||
if (path === 'languages.json') {
|
||||
var pathInStage = 'shared/resources/languages.json';
|
||||
this.moveToBuildDir(this.localesFile, pathInStage);
|
||||
return;
|
||||
}
|
||||
|
||||
// Add not only file itself but all its hidpi-suffixed versions.
|
||||
let fileNameRegexp = new RegExp(
|
||||
'^' + file.leafName.replace(/(\.[a-z]+$)/, '((@.*x)?(\\$1))') + '$');
|
||||
|
||||
utils.ls(utils.getFile(utils.dirname(file.path)), false).forEach(
|
||||
function(listFile) {
|
||||
var matches = fileNameRegexp.exec(listFile.leafName);
|
||||
if (matches) {
|
||||
var pathInStage = 'shared/resources/' +
|
||||
path.replace(matches[3], matches[1]);
|
||||
this.moveToBuildDir(listFile, pathInStage);
|
||||
}
|
||||
}.bind(this));
|
||||
|
||||
if (file.isDirectory()) {
|
||||
utils.ls(file, true).forEach(function(fileInResources) {
|
||||
var pathInStage = 'shared' +
|
||||
fileInResources.path.substr(this.gaia.sharedFolder.path.length);
|
||||
this.moveToBuildDir(fileInResources, pathInStage);
|
||||
}.bind(this));
|
||||
}
|
||||
|
||||
if (path === 'media/ringtones/' && this.gaia.distributionDir &&
|
||||
utils.getFile(this.gaia.distributionDir, 'ringtones').exists()) {
|
||||
this.moveToBuildDir(utils.getFile(this.gaia.distributionDir, 'ringtones'),
|
||||
'ringtones');
|
||||
}
|
||||
};
|
||||
|
||||
WebappShared.prototype.pushLocale = function(name) {
|
||||
var localeFolder = utils.getFile(this.gaia.sharedFolder.path, 'locales',
|
||||
name);
|
||||
if (!localeFolder.exists()) {
|
||||
throw new Error('Using inexistent shared locale: ' + name + ' from: ' +
|
||||
this.webapp.domain);
|
||||
}
|
||||
// And the locale folder itself
|
||||
this.moveToBuildDir(localeFolder, 'shared/locales/' + name );
|
||||
utils.ls(localeFolder, true).forEach(function(fileInSharedLocales) {
|
||||
|
||||
var relativePath =
|
||||
fileInSharedLocales.path.substr(this.config.GAIA_DIR.length + 1);
|
||||
|
||||
this.moveToBuildDir(fileInSharedLocales, relativePath);
|
||||
}.bind(this));
|
||||
};
|
||||
|
||||
WebappShared.prototype.pushElements = function(path) {
|
||||
var filePath = this.gaia.sharedFolder.path;
|
||||
filePath = utils.joinPath(filePath, 'elements');
|
||||
|
||||
var elems = path.split('/');
|
||||
|
||||
for (var i = 0; i < elems.length; i++) {
|
||||
filePath = utils.joinPath(filePath, elems[i]);
|
||||
if (elems[i] === 'locales') {
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
var file = utils.getFile(filePath);
|
||||
if (!file.exists()) {
|
||||
throw new Error('Using inexistent shared elements file: ' + path +
|
||||
' from: ' + this.webapp.domain);
|
||||
}
|
||||
var pathInStage = 'shared/elements/' + path;
|
||||
this.moveToBuildDir(file, pathInStage);
|
||||
|
||||
// Handle image assets for web components
|
||||
var paths = path.split('/');
|
||||
if (paths.length <= 1) {
|
||||
return;
|
||||
}
|
||||
|
||||
var elementName = String(paths.shift());
|
||||
|
||||
// Only handle web components for now (start with gaia)
|
||||
if (elementName.indexOf('gaia') !== 0) {
|
||||
return;
|
||||
}
|
||||
|
||||
// Copy possible resources from components.
|
||||
var resources = ['style.css', 'css', 'js', 'images', 'locales', 'fonts'];
|
||||
resources.forEach(function(resource) {
|
||||
var eachFile = utils.getFile(this.gaia.sharedFolder.path, 'elements',
|
||||
elementName, resource);
|
||||
if (eachFile.exists()) {
|
||||
var stagePath = 'shared/' +
|
||||
utils.relativePath(this.gaia.sharedFolder.path, eachFile.path);
|
||||
this.moveToBuildDir(eachFile, stagePath);
|
||||
}
|
||||
}, this);
|
||||
};
|
||||
|
||||
/**
|
||||
* Push file to build_stage/<app>/shared/<type> by their type
|
||||
*/
|
||||
WebappShared.prototype.pushFileByType = function(kind, path) {
|
||||
if (path.match(/@[\d\.]+x\.(png|gif|jpg)$/)) {
|
||||
utils.log('WARNNING: You are using hidpi image directly in html.');
|
||||
}
|
||||
|
||||
switch (kind) {
|
||||
case 'pages':
|
||||
if (this.used.pages.indexOf(path) === -1) {
|
||||
this.used.pages.push(path);
|
||||
this.copyPage(path);
|
||||
}
|
||||
break;
|
||||
case 'js':
|
||||
if (this.used.js.indexOf(path) === -1) {
|
||||
this.used.js.push(path);
|
||||
this.pushJS(path);
|
||||
}
|
||||
break;
|
||||
case 'resources':
|
||||
if (this.used.resources.indexOf(path) === -1) {
|
||||
this.used.resources.push(path);
|
||||
this.pushResource(path);
|
||||
}
|
||||
break;
|
||||
case 'style':
|
||||
var styleName = path.substr(0, path.lastIndexOf('.'));
|
||||
if (this.used.styles.indexOf(styleName) === -1) {
|
||||
this.used.styles.push(styleName);
|
||||
this.copyBuildingBlock(styleName, 'style');
|
||||
}
|
||||
break;
|
||||
case 'style_unstable':
|
||||
var unstableStyleName = path.substr(0, path.lastIndexOf('.'));
|
||||
if (this.used.unstable_styles.indexOf(unstableStyleName) === -1) {
|
||||
this.used.unstable_styles.push(unstableStyleName);
|
||||
this.copyBuildingBlock(unstableStyleName, 'style_unstable');
|
||||
}
|
||||
break;
|
||||
case 'locales':
|
||||
var localeName = utils.dirname(path);
|
||||
if (this.used.locales.indexOf(localeName) === -1) {
|
||||
this.used.locales.push(localeName);
|
||||
this.pushLocale(localeName);
|
||||
}
|
||||
break;
|
||||
case 'elements':
|
||||
if (this.used.elements.indexOf(path) == -1) {
|
||||
this.used.elements.push(path);
|
||||
this.pushElements(path);
|
||||
}
|
||||
break;
|
||||
}
|
||||
};
|
||||
|
||||
/**
|
||||
* Filter <script...>|<link..> keyword in HTML. If these external resources are
|
||||
* imported from '/shared', we should move them to build_stage/<app>/shared
|
||||
*/
|
||||
WebappShared.prototype.filterSharedUsage = function(file) {
|
||||
var SHARED_USAGE =
|
||||
/<(?:script|link).+=['"]\.?\.?\/?shared\/([^\/]+)\/([^'"\s]+)['"]/g;
|
||||
var content = utils.getFileContent(file);
|
||||
var matches = null;
|
||||
while ((matches = SHARED_USAGE.exec(content)) !== null) {
|
||||
let kind = matches[1]; // js | locales | resources | style
|
||||
let path = matches[2];
|
||||
this.pushFileByType(kind, path);
|
||||
}
|
||||
};
|
||||
|
||||
/**
|
||||
* Filter @import keyword in CSS. If these imported CSS are from '/shared',
|
||||
* we should move them to build_stage/<app>/shared
|
||||
*/
|
||||
WebappShared.prototype.filterSharedCSSImport = function(file) {
|
||||
var COMMENTED =
|
||||
/(?:\/\*(?:[\s\S]*?)\*\/)|(?:([\s;])+\/\/(?:.*)$)/gm;
|
||||
var CSS_IMPORT =
|
||||
/@import (?:url\()?['"].*shared\/([^\/]+)\/([^'"\s]+)['"](?:\))?.*;$/gm;
|
||||
var content = utils.getFileContent(file).replace(COMMENTED, '');
|
||||
var matches = null;
|
||||
while ((matches = CSS_IMPORT.exec(content)) !== null) {
|
||||
let kind = matches[1]; // imported css file
|
||||
let path = matches[2];
|
||||
this.pushFileByType(kind, path);
|
||||
}
|
||||
};
|
||||
|
||||
/**
|
||||
* Filter file by extenstion
|
||||
*/
|
||||
WebappShared.prototype.filterFileByExtenstion = function(type, file) {
|
||||
var EXTENSIONS_WHITELIST = [type];
|
||||
var extension = utils.getExtension(file.leafName);
|
||||
return file.isFile() && EXTENSIONS_WHITELIST.indexOf(extension) !== -1;
|
||||
};
|
||||
|
||||
/**
|
||||
* copyShared scan '/shared' resources which have ever imported by webapps
|
||||
* and copy them to '/build_stage' with their proper structures.
|
||||
*/
|
||||
WebappShared.prototype.copyShared = function() {
|
||||
// If config.BUILD_APP_NAME isn't `*`, we only accept one webapp
|
||||
if (this.config.BUILD_APP_NAME !== '*' &&
|
||||
this.webapp.sourceDirectoryName !== this.config.BUILD_APP_NAME) {
|
||||
return;
|
||||
}
|
||||
// Zip generation is not needed for external apps, aplication data
|
||||
// is copied to profile webapps folder in webapp-manifests.js
|
||||
if (utils.isExternalApp(this.webapp)) {
|
||||
return;
|
||||
}
|
||||
var sourceDirectoryFile = utils.getFile(this.webapp.sourceDirectoryFilePath);
|
||||
var files = utils.ls(sourceDirectoryFile, true);
|
||||
files.filter(this.filterFileByExtenstion.bind(this, 'html')).forEach(
|
||||
this.filterSharedUsage.bind(this));
|
||||
files.filter(this.filterFileByExtenstion.bind(this, 'css')).forEach(
|
||||
this.filterSharedCSSImport.bind(this));
|
||||
this.customizeShared();
|
||||
};
|
||||
|
||||
WebappShared.prototype.customizeShared = function() {
|
||||
var self = this;
|
||||
var sharedDataFile = utils.getFile(this.webapp.buildDirectoryFilePath,
|
||||
'gaia_shared.json');
|
||||
if (sharedDataFile.exists()) {
|
||||
var sharedData = JSON.parse(utils.getFileContent(sharedDataFile));
|
||||
Object.keys(sharedData).forEach(function(kind) {
|
||||
sharedData[kind].forEach(function(path) {
|
||||
self.pushFileByType(kind, path);
|
||||
});
|
||||
});
|
||||
}
|
||||
};
|
||||
|
||||
WebappShared.prototype.execute = function(options) {
|
||||
this.setOptions(options);
|
||||
this.copyShared();
|
||||
};
|
||||
|
||||
function execute(config) {
|
||||
var gaia = utils.gaia.getInstance(config);
|
||||
gaia.rebuildWebapps.forEach(function(webapp) {
|
||||
(new WebappShared()).execute({
|
||||
config: config, gaia: gaia, webapp: webapp});
|
||||
});
|
||||
}
|
||||
|
||||
exports.execute = execute;
|
||||
exports.WebappShared = WebappShared;
|
||||
Loading…
Reference in a new issue