@kirz/expo-content-blocker
Version:
Apply content blocker rules to Safari
207 lines (206 loc) • 11.2 kB
JavaScript
;
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
var desc = Object.getOwnPropertyDescriptor(m, k);
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
desc = { enumerable: true, get: function() { return m[k]; } };
}
Object.defineProperty(o, k2, desc);
}) : (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
o[k2] = m[k];
}));
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
Object.defineProperty(o, "default", { enumerable: true, value: v });
}) : function(o, v) {
o["default"] = v;
});
var __importStar = (this && this.__importStar) || function (mod) {
if (mod && mod.__esModule) return mod;
var result = {};
if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
__setModuleDefault(result, mod);
return result;
};
var __importDefault = (this && this.__importDefault) || function (mod) {
return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.withBlockerIos = void 0;
const config_plugins_1 = require("@expo/config-plugins");
const Xcodeproj_js_1 = require("@expo/config-plugins/build/ios/utils/Xcodeproj.js");
const assert_1 = __importDefault(require("assert"));
const fs = __importStar(require("fs"));
const path = __importStar(require("path"));
const BlockerProviderLog_ts_1 = require("./support/BlockerProviderLog.ts");
const FileManager_1 = require("./support/FileManager");
const NseUpdaterManager_1 = __importDefault(require("./support/NseUpdaterManager"));
const getEasManagedCredentialsConfigExtra_1 = __importDefault(require("./support/eas/getEasManagedCredentialsConfigExtra"));
const iosConstants_1 = require("./support/iosConstants");
const withAppEnvironment = (config) => {
return (0, config_plugins_1.withEntitlementsPlist)(config, (newConfig) => {
return newConfig;
});
};
const withEasManagedCredentials = (config) => {
(0, assert_1.default)(config.ios?.bundleIdentifier, "Missing 'ios.bundleIdentifier' in app config.");
config.extra = (0, getEasManagedCredentialsConfigExtra_1.default)(config);
return config;
};
const withAdblockNSE = (config) => {
const pluginDir = require.resolve("../jest.config.js");
const sourceDir = path.join(pluginDir, "../src/serviceExtensionFiles/");
return (0, config_plugins_1.withDangerousMod)(config, [
"ios",
async (config) => {
const iosPath = path.join(config.modRequest.projectRoot, "ios");
/* COPY OVER EXTENSION FILES */
fs.mkdirSync(`${iosPath}/${iosConstants_1.NSE_TARGET_NAME}`, { recursive: true });
for (let i = 0; i < iosConstants_1.NSE_EXT_FILES.length; i++) {
const extFile = iosConstants_1.NSE_EXT_FILES[i];
const targetFile = `${iosPath}/${iosConstants_1.NSE_TARGET_NAME}/${extFile}`;
await FileManager_1.FileManager.copyFile(`${sourceDir}${extFile}`, targetFile);
}
// Copy NSE source file either from configuration-provided location, falling back to the default one.
// const sourcePath = `${sourceDir}${NSE_SOURCE_FILE}`;
// const targetFile = `${iosPath}/${NSE_TARGET_NAME}/${NSE_SOURCE_FILE}`;
// await FileManager.copyFile(`${sourcePath}`, targetFile);
/* MODIFY COPIED EXTENSION FILES */
const nseUpdater = new NseUpdaterManager_1.default(iosPath);
await nseUpdater.updateNSEEntitlements(`group.${config.ios?.bundleIdentifier}.SafariAdsBlocker`);
await nseUpdater.updateNSEBundleVersion(config.ios?.buildNumber ?? iosConstants_1.DEFAULT_BUNDLE_VERSION);
await nseUpdater.updateNSEBundleShortVersion(config?.version ?? iosConstants_1.DEFAULT_BUNDLE_SHORT_VERSION);
return config;
},
]);
};
const withCopyNativeModules = (config) => {
const pluginDir = require.resolve("../jest.config.js");
const sourceDir = path.join(pluginDir, "../build/nativeModules/");
return (0, config_plugins_1.withDangerousMod)(config, [
"ios",
async (config) => {
const iosPath = path.join(config.modRequest.projectRoot, "ios");
for (let i = 0; i < iosConstants_1.NSE_EXT_FILES.length; i++) {
const extFile = iosConstants_1.NATIVE_MODULES_FILES[i];
const targetFile = `${iosPath}/${config.modRequest.projectName}/${extFile}`;
await FileManager_1.FileManager.copyFile(`${sourceDir}${extFile}`, targetFile);
}
return config;
},
]);
};
const withAppGroupPermissions = (config) => {
const APP_GROUP_KEY = "com.apple.security.application-groups";
return (0, config_plugins_1.withEntitlementsPlist)(config, (newConfig) => {
if (!Array.isArray(newConfig.modResults[APP_GROUP_KEY])) {
newConfig.modResults[APP_GROUP_KEY] = [];
}
const modResultsArray = newConfig.modResults[APP_GROUP_KEY];
const entitlement = `group.${newConfig?.ios?.bundleIdentifier || ""}.SafariAdsBlocker`;
if (modResultsArray.indexOf(entitlement) !== -1) {
return newConfig;
}
modResultsArray.push(entitlement);
return newConfig;
});
};
const withAdblockXcodeProject = (config, props) => {
return (0, config_plugins_1.withXcodeProject)(config, (newConfig) => {
const xcodeProject = newConfig.modResults;
if (xcodeProject.pbxTargetByName(iosConstants_1.NSE_TARGET_NAME)) {
BlockerProviderLog_ts_1.BlockerProviderLog.log(`${iosConstants_1.NSE_TARGET_NAME} already exists in project. Skipping...`);
return newConfig;
}
// Create new PBXGroup for the extension
const extGroup = xcodeProject.addPbxGroup([...iosConstants_1.NSE_EXT_FILES], iosConstants_1.NSE_TARGET_NAME, iosConstants_1.NSE_TARGET_NAME);
// Add the new PBXGroup to the top level group. This makes the
// files / folder appear in the file explorer in Xcode.
const groups = xcodeProject.hash.project.objects["PBXGroup"];
Object.keys(groups).forEach(function (key) {
if (typeof groups[key] === "object" &&
groups[key].name === undefined &&
groups[key].path === undefined) {
xcodeProject.addToPbxGroup(extGroup.uuid, key);
}
});
// WORK AROUND for codeProject.addTarget BUG
// Xcode projects don't contain these if there is only one target
// An upstream fix should be made to the code referenced in this link:
// - https://github.com/apache/cordova-node-xcode/blob/8b98cabc5978359db88dc9ff2d4c015cba40f150/lib/pbxProject.js#L860
const projObjects = xcodeProject.hash.project.objects;
projObjects["PBXTargetDependency"] =
projObjects["PBXTargetDependency"] || {};
projObjects["PBXContainerItemProxy"] =
projObjects["PBXTargetDependency"] || {};
// Add the NSE target
// This adds PBXTargetDependency and PBXContainerItemProxy for you
const nseTarget = xcodeProject.addTarget(iosConstants_1.NSE_TARGET_NAME, "app_extension", iosConstants_1.NSE_TARGET_NAME, `${config.ios?.bundleIdentifier}.SafariAdsBlocker`);
// Add build phases to the new target
xcodeProject.addBuildPhase(["SafariAdsBlockerRequestHandler.swift"], "PBXSourcesBuildPhase", "Sources", nseTarget.uuid);
xcodeProject.addBuildPhase(["rules.json"], "PBXResourcesBuildPhase", "Resources", nseTarget.uuid);
xcodeProject.addBuildPhase([], "PBXFrameworksBuildPhase", "Frameworks", nseTarget.uuid);
// Edit the Deployment info of the new Target, only IphoneOS and Targeted Device Family
// However, can be more
const configurations = xcodeProject.pbxXCBuildConfigurationSection();
for (const key in configurations) {
if (typeof configurations[key].buildSettings !== "undefined" &&
configurations[key].buildSettings.PRODUCT_NAME ===
`"${iosConstants_1.NSE_TARGET_NAME}"`) {
const buildSettingsObj = configurations[key].buildSettings;
buildSettingsObj.SWIFT_VERSION = iosConstants_1.SWIFT_VERSION;
buildSettingsObj.IPHONEOS_DEPLOYMENT_TARGET =
iosConstants_1.IPHONEOS_DEPLOYMENT_TARGET;
buildSettingsObj.TARGETED_DEVICE_FAMILY = iosConstants_1.TARGETED_DEVICE_FAMILY;
buildSettingsObj.CODE_SIGN_ENTITLEMENTS = `${iosConstants_1.NSE_TARGET_NAME}/${iosConstants_1.NSE_TARGET_NAME}.entitlements`;
buildSettingsObj.CODE_SIGN_STYLE = "Automatic";
}
}
return newConfig;
});
};
const withMainTargetXcodeProject = (config, props) => {
return (0, config_plugins_1.withXcodeProject)(config, (newConfig) => {
const projectName = (0, Xcodeproj_js_1.getProjectName)(newConfig.modRequest.projectRoot);
for (let i = 0; i < iosConstants_1.NATIVE_MODULES_FILES.length; i++) {
const filePath = path.join(projectName, iosConstants_1.NATIVE_MODULES_FILES[i]);
const groupName = path.dirname(filePath);
(0, Xcodeproj_js_1.addBuildSourceFileToGroup)({
filepath: filePath,
groupName,
project: newConfig.modResults,
});
}
return newConfig;
});
};
const withIosSwiftBridgingHeader = (config) => {
return (0, config_plugins_1.withXcodeProject)(config, async (newConfig) => {
const iosRoot = path.join(newConfig.modRequest.projectRoot, "ios");
const file = await FileManager_1.FileManager.readFile(`${iosRoot}/${newConfig.modRequest.projectName}/${newConfig.modRequest.projectName}-Bridging-Header.h`);
const matches = file.match(iosConstants_1.NSE_BRIDGE_HEADER_SNIPPET);
if (matches) {
BlockerProviderLog_ts_1.BlockerProviderLog.log("Add BridgingHeader. Skipping...");
}
else {
fs.appendFile(`${iosRoot}/${newConfig.modRequest.projectName}/${newConfig.modRequest.projectName}-Bridging-Header.h`, iosConstants_1.NSE_BRIDGE_HEADER_SNIPPET, (err) => {
if (err) {
BlockerProviderLog_ts_1.BlockerProviderLog.error(`Error writing to ${newConfig.modRequest.projectName}-Bridging-Header.h}`);
}
});
}
return newConfig;
});
};
const withBlockerIos = (config, props) => {
config = withAppEnvironment(config, props);
config = withAppGroupPermissions(config, props);
config = withAdblockNSE(config, props);
// config = withCopyNativeModules(config, props);
config = withMainTargetXcodeProject(config, props);
config = withAdblockXcodeProject(config, props);
config = withEasManagedCredentials(config, props);
config = withIosSwiftBridgingHeader(config);
return config;
};
exports.withBlockerIos = withBlockerIos;