Spaces:
Sleeping
Sleeping
File size: 64,486 Bytes
7aec436 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 |
import {EventTarget, CustomEvent} from '../common/event-target';
import sha256 from './sha256';
import escapeXML from '../common/escape-xml';
import largeAssets from './large-assets';
import request from '../common/request';
import pngToAppleICNS from './icns';
import {buildId, verifyBuildId} from './build-id';
import {encode} from './base85';
import {parsePlist, generatePlist} from './plist';
import {APP_NAME, WEBSITE, COPYRIGHT_NOTICE, ACCENT_COLOR} from './brand';
import {OutdatedPackagerError} from '../common/errors';
import {darken} from './colors';
import {Adapter} from './adapter';
import encodeBigString from './encode-big-string';
const PROGRESS_LOADED_SCRIPTS = 0.1;
// Used by environments that fetch the entire compressed project before calling loadProject()
const PROGRESS_FETCHED_COMPRESSED = 0.75;
const PROGRESS_EXTRACTED_COMPRESSED = 0.98;
// Used by environments that pass a project.json into loadProject() and fetch assets separately
const PROGRESS_FETCHED_PROJECT_JSON = 0.2;
const PROGRESS_FETCHED_ASSETS = 0.98;
const removeUnnecessaryEmptyLines = (string) => string.split('\n')
.filter((line, index, array) => {
if (index === 0 || index === array.length - 1) return true;
if (line.trim().length === 0 && array[index - 1].trim().length === 0) return false;
return true;
})
.join('\n');
export const getJSZip = async () => (await import(/* webpackChunkName: "jszip" */ 'jszip')).default;
const setFileFast = (zip, path, data) => {
zip.files[path] = data;
};
const SELF_LICENSE = {
title: APP_NAME,
homepage: WEBSITE,
license: COPYRIGHT_NOTICE
};
const SCRATCH_LICENSE = {
title: 'Scratch',
homepage: 'https://scratch.mit.edu/',
license: `Copyright (c) 2016, Massachusetts Institute of Technology
All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.`
};
const ELECTRON_LICENSE = {
title: 'Electron',
homepage: 'https://www.electronjs.org/',
license: `Copyright (c) Electron contributors
Copyright (c) 2013-2020 GitHub Inc.
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.`
};
const COPYRIGHT_HEADER = `/*!
Parts of this script are from the ${APP_NAME} <${WEBSITE}>, licensed as follows:
${SELF_LICENSE.license}
Parts of this script are from Scratch <https://scratch.mit.edu/>, licensed as follows:
${SCRATCH_LICENSE.license}
*/\n`;
const generateChromiumLicenseHTML = (licenses) => {
const style = `<style>body { font-family: sans-serif; }</style>`;
const pretext = `<h2>The following entries were added by the ${APP_NAME}</h2>`;
const convertedLicenses = licenses.map((({title, license, homepage}, index) => `
<div class="product">
<span class="title">${escapeXML(title)}</span>
<span class="homepage"><a href="${escapeXML(homepage)}">homepage</a></span>
<input type="checkbox" hidden id="p4-${index}">
<label class="show" for="p4-${index}" tabindex="0"></label>
<div class="licence">
<pre>${escapeXML(license)}</pre>
</div>
</div>
`));
return `${style}${pretext}${convertedLicenses.join('\n')}`;
};
// Unique identifier for the app. If this changes, things like local cloud variables will be lost.
// This should be in reverse-DNS format.
// https://developer.apple.com/documentation/bundleresources/information_property_list/cfbundleidentifier
const CFBundleIdentifier = 'CFBundleIdentifier';
// Even if you fork the packager, you shouldn't change this string unless you want packaged macOS apps
// to lose all their data.
const bundleIdentifierPrefix = 'org.turbowarp.packager.userland.';
// CFBundleName is displayed in the menu bar.
// I'm not actually sure where CFBundleDisplayName is displayed.
// Documentation says that CFBundleName is only supposed to be 15 characters and that CFBundleDisplayName
// should be used for longer names, but in reality CFBundleName seems to not have a length limit.
// https://developer.apple.com/documentation/bundleresources/information_property_list/cfbundlename
// https://developer.apple.com/documentation/bundleresources/information_property_list/cfbundledisplayname
const CFBundleName = 'CFBundleName';
const CFBundleDisplayName = 'CFBundleDisplayName';
// The name of the executable in the .app/Contents/MacOS folder
// https://developer.apple.com/documentation/bundleresources/information_property_list/cfbundleexecutable
const CFBundleExecutable = 'CFBundleExecutable';
// macOS's "About" screen will display: "Version {CFBundleShortVersionString} ({CFBundleVersion})"
// Apple's own apps are inconsistent about what they display here. Some apps set both of these to the same thing
// so you see eg. "Version 15.0 (15.0)" while others set CFBundleShortVersionString to a semver-like and
// treat CFBundleVersion as a simple build number eg. "Version 1.4.0 (876)"
// Apple's documentation says both of these are supposed to be major.minor.patch, but in reality it doesn't
// even have to contain numbers and everything seems to work fine.
// https://developer.apple.com/documentation/bundleresources/information_property_list/cfbundleversion
// https://developer.apple.com/documentation/bundleresources/information_property_list/cfbundleshortversionstring
const CFBundleVersion = 'CFBundleVersion';
const CFBundleShortVersionString = 'CFBundleShortVersionString';
// Describes the category of the app
// https://developer.apple.com/documentation/bundleresources/information_property_list/lsapplicationcategorytype
const LSApplicationCategoryType = 'LSApplicationCategoryType';
const generateMacReadme = (options) => `When you try to double click on the app to run it, you will probably see this warning:
"${options.app.packageName} cannot be opened because the developer cannot be verified."
This is normal. Press cancel.
To run the app:
1) Control+click on the app file (${options.app.packageName} in the same folder as this document) and select "Open".
2) If a warning appears, select "Open" if it's an option.
3) If a warning appears but "Open" isn't an option, press "Cancel" and repeat from step 1.
The open button will appear the second time the warning appears.
After completing these steps, the app should run without any further warnings.
Feel free to drag the app into your Applications folder.
`;
/**
* @param {string} packageName
*/
const validatePackageName = (packageName) => {
// Characters considered unsafe filenames on Windows
const BLOCKLIST = ['/', '\\', ':', '*', '?', '<', '>', '|'];
if (BLOCKLIST.some((i) => packageName.includes(i))) {
throw new Error(`Invalid package name: ${packageName}. It must not use the characters: ${BLOCKLIST.join(' ')}`)
}
};
class Packager extends EventTarget {
constructor () {
super();
this.project = null;
this.options = Packager.DEFAULT_OPTIONS();
this.aborted = false;
this.used = false;
}
abort () {
if (!this.aborted) {
this.aborted = true;
this.dispatchEvent(new Event('abort'));
}
}
ensureNotAborted () {
if (this.aborted) {
throw new Error('Aborted');
}
}
async fetchLargeAsset (name, type) {
this.ensureNotAborted();
const asset = largeAssets[name];
if (!asset) {
throw new Error(`Invalid asset: ${name}`);
}
if (typeof __ASSETS__ !== 'undefined' && __ASSETS__[asset.src]) {
return __ASSETS__[asset.src];
}
const dispatchProgress = (progress) => this.dispatchEvent(new CustomEvent('large-asset-fetch', {
detail: {
asset: name,
progress
}
}));
dispatchProgress(0);
let result;
let cameFromCache = false;
try {
const cached = await Adapter.getCachedAsset(asset);
if (cached) {
result = cached;
cameFromCache = true;
dispatchProgress(0.5);
}
} catch (e) {
console.warn(e);
}
if (!result) {
let url = asset.src;
if (asset.useBuildId) {
url += `?${buildId}`;
}
result = await request({
url,
type,
estimatedSize: asset.estimatedSize,
progressCallback: (progress) => {
dispatchProgress(progress);
},
abortTarget: this
});
}
if (asset.useBuildId && !verifyBuildId(buildId, result)) {
throw new OutdatedPackagerError('Build ID does not match.');
}
if (asset.sha256) {
const hash = await sha256(result);
if (hash !== asset.sha256) {
throw new Error(`Hash mismatch for ${name}, found ${hash} but expected ${asset.sha256}`);
}
}
if (!cameFromCache) {
try {
await Adapter.cacheAsset(asset, result);
} catch (e) {
console.warn(e);
}
}
dispatchProgress(1);
return result;
}
getAddonOptions () {
return {
...this.options.chunks,
specialCloudBehaviors: this.options.cloudVariables.specialCloudBehaviors,
unsafeCloudBehaviors: this.options.cloudVariables.unsafeCloudBehaviors,
pause: this.options.controls.pause.enabled
};
}
async loadResources () {
const texts = [COPYRIGHT_HEADER];
if (this.project.analysis.usesMusic) {
texts.push(await this.fetchLargeAsset('scaffolding', 'text'));
} else {
texts.push(await this.fetchLargeAsset('scaffolding-min', 'text'));
}
if (Object.values(this.getAddonOptions()).some((i) => i)) {
texts.push(await this.fetchLargeAsset('addons', 'text'));
}
this.script = texts.join('\n').replace(/<\/script>/g,"</scri'+'pt>");
}
computeWindowSize () {
let width = this.options.stageWidth;
let height = this.options.stageHeight;
if (
this.options.controls.greenFlag.enabled ||
this.options.controls.stopAll.enabled ||
this.options.controls.pause.enabled
) {
height += 48;
}
return {width, height};
}
getPlistPropertiesForPrimaryExecutable () {
return {
[CFBundleIdentifier]: `${bundleIdentifierPrefix}${this.options.app.packageName}`,
// For simplicity, we'll set these to the same thing
[CFBundleName]: this.options.app.windowTitle,
[CFBundleDisplayName]: this.options.app.windowTitle,
// We do rename the executable
[CFBundleExecutable]: this.options.app.packageName,
// For simplicity, we'll set these to the same thing
[CFBundleVersion]: this.options.app.version,
[CFBundleShortVersionString]: this.options.app.version,
// Most items generated by the packager are games
[LSApplicationCategoryType]: 'public.app-category.games'
};
}
async updatePlist (zip, name, newProperties) {
const contents = await zip.file(name).async('string');
const plist = parsePlist(contents);
Object.assign(plist, newProperties);
zip.file(name, generatePlist(plist));
}
async addNwJS (projectZip) {
const packageName = this.options.app.packageName;
validatePackageName(packageName);
const nwjsBuffer = await this.fetchLargeAsset(this.options.target, 'arraybuffer');
const nwjsZip = await (await getJSZip()).loadAsync(nwjsBuffer);
const isWindows = this.options.target.startsWith('nwjs-win');
const isMac = this.options.target === 'nwjs-mac';
const isLinux = this.options.target.startsWith('nwjs-linux');
// NW.js Windows folder structure:
// * (root)
// +-- nwjs-v0.49.0-win-x64
// +-- nw.exe (executable)
// +-- credits.html
// +-- (project data)
// +-- ...
// NW.js macOS folder structure:
// * (root)
// +-- nwjs-v0.49.0-osx-64
// +-- credits.html
// +-- nwjs.app
// +-- Contents
// +-- Resources
// +-- app.icns (icon)
// +-- app.nw
// +-- (project data)
// +-- MacOS
// +-- nwjs (executable)
// +-- ...
// the first folder, something like "nwjs-v0.49.0-win-64"
const nwjsPrefix = Object.keys(nwjsZip.files)[0].split('/')[0];
const zip = new (await getJSZip());
// Copy NW.js files to the right place
for (const path of Object.keys(nwjsZip.files)) {
const file = nwjsZip.files[path];
let newPath = path.replace(nwjsPrefix, packageName);
if (isWindows) {
newPath = newPath.replace('nw.exe', `${packageName}.exe`);
} else if (isMac) {
newPath = newPath.replace('nwjs.app', `${packageName}.app`);
} else if (isLinux) {
newPath = newPath.replace(/nw$/, packageName);
}
setFileFast(zip, newPath, file);
}
const ICON_NAME = 'icon.png';
const icon = await Adapter.getAppIcon(this.options.app.icon);
const manifest = {
name: packageName,
main: 'main.js',
version: this.options.app.version,
window: {
width: this.computeWindowSize().width,
height: this.computeWindowSize().height,
icon: ICON_NAME
}
};
let dataPrefix;
if (isWindows) {
dataPrefix = `${packageName}/`;
} else if (isMac) {
zip.file(`${packageName}/How to run ${packageName}.txt`, generateMacReadme(this.options));
const icnsData = await pngToAppleICNS(icon);
zip.file(`${packageName}/${packageName}.app/Contents/Resources/app.icns`, icnsData);
dataPrefix = `${packageName}/${packageName}.app/Contents/Resources/app.nw/`;
} else if (isLinux) {
const startScript = `#!/bin/bash
cd "$(dirname "$0")"
./${packageName}`;
zip.file(`${packageName}/start.sh`, startScript, {
unixPermissions: 0o100755
});
dataPrefix = `${packageName}/`;
}
// Copy project files and extra NW.js files to the right place
for (const path of Object.keys(projectZip.files)) {
setFileFast(zip, dataPrefix + path, projectZip.files[path]);
}
zip.file(dataPrefix + ICON_NAME, icon);
zip.file(dataPrefix + 'package.json', JSON.stringify(manifest, null, 4));
zip.file(dataPrefix + 'main.js', `
const start = () => nw.Window.open('index.html', {
position: 'center',
new_instance: true
});
nw.App.on('open', start);
start();`);
const creditsHtmlPath = `${packageName}/credits.html`;
const creditsHtml = await zip.file(creditsHtmlPath).async('string');
zip.file(creditsHtmlPath, creditsHtml + generateChromiumLicenseHTML([
SELF_LICENSE,
SCRATCH_LICENSE
]));
return zip;
}
async addElectron (projectZip) {
const packageName = this.options.app.packageName;
validatePackageName(packageName);
const buffer = await this.fetchLargeAsset(this.options.target, 'arraybuffer');
const electronZip = await (await getJSZip()).loadAsync(buffer);
const isWindows = this.options.target.includes('win');
const isMac = this.options.target.includes('mac');
const isLinux = this.options.target.includes('linux');
// See https://www.electronjs.org/docs/latest/tutorial/application-distribution#manual-distribution
// Electron Windows/Linux folder structure:
// * (root)
// +-- electron.exe (executable)
// +-- resources
// +-- default_app.asar (we will delete this)
// +-- app (we will create this)
// +-- index.html and the other project files (we will create this)
// +-- LICENSES.chromium.html and everything else
// Electron macOS folder structure:
// * (root)
// +-- Electron.app
// +-- Contents
// +-- Info.plist (we must update)
// +-- MacOS
// +-- Electron (executable)
// +-- Frameworks
// +-- Electron Helper.app
// +-- Contents
// +-- Info.plist (we must update)
// +-- Electron Helper (GPU).app
// +-- Contents
// +-- Info.plist (we must update)
// +-- Electron Helper (Renderer).app
// +-- Contents
// +-- Info.plist (we must update)
// +-- Electron Helper (Plugin).app
// +-- Contents
// +-- Info.plist (we must update)
// +-- and several other helpers which we won't touch
// +-- Resources
// +-- default_app.asar (we will delete this)
// +-- electron.icns (we will update this)
// +-- app (we will create this)
// +-- index.html and the other project files (we will create this)
// +-- LICENSES.chromium.html and other license files
const zip = new (await getJSZip());
for (const path of Object.keys(electronZip.files)) {
const file = electronZip.files[path];
// On Windows and Linux, make an inner folder inside the zip. Zip extraction tools will sometimes make
// a mess if you don't make an inner folder.
// On macOS, the .app is already itself a folder already and macOS will always make a folder for the
// extracted files if there's multiple files at the root.
let newPath;
if (isMac) {
newPath = path;
} else {
newPath = `${packageName}/${path}`;
}
if (isWindows) {
newPath = newPath.replace('electron.exe', `${packageName}.exe`);
} else if (isMac) {
newPath = newPath.replace('Electron.app', `${packageName}.app`);
newPath = newPath.replace(/Electron$/, packageName);
} else if (isLinux) {
newPath = newPath.replace(/electron$/, packageName);
}
setFileFast(zip, newPath, file);
}
const rootPrefix = isMac ? '' : `${packageName}/`;
const creditsHtml = await zip.file(`${rootPrefix}LICENSES.chromium.html`).async('string');
zip.file(`${rootPrefix}licenses.html`, creditsHtml + generateChromiumLicenseHTML([
SELF_LICENSE,
SCRATCH_LICENSE,
ELECTRON_LICENSE
]));
zip.remove(`${rootPrefix}LICENSE.txt`);
zip.remove(`${rootPrefix}LICENSES.chromium.html`);
zip.remove(`${rootPrefix}LICENSE`);
zip.remove(`${rootPrefix}version`);
zip.remove(`${rootPrefix}resources/default_app.asar`);
const contentsPrefix = isMac ? `${rootPrefix}${packageName}.app/Contents/` : rootPrefix;
const resourcesPrefix = isMac ? `${contentsPrefix}Resources/app/` : `${contentsPrefix}resources/app/`;
const electronMainName = 'electron-main.js';
const iconName = 'icon.png';
const icon = await Adapter.getAppIcon(this.options.app.icon);
zip.file(`${resourcesPrefix}${iconName}`, icon);
const manifest = {
name: packageName,
main: electronMainName,
version: this.options.app.version
};
zip.file(`${resourcesPrefix}package.json`, JSON.stringify(manifest, null, 4));
const mainJS = `'use strict';
const {app, BrowserWindow, Menu, shell, screen, dialog} = require('electron');
const path = require('path');
const isWindows = process.platform === 'win32';
const isMac = process.platform === 'darwin';
const isLinux = process.platform === 'linux';
if (isMac) {
Menu.setApplicationMenu(Menu.buildFromTemplate([
{ role: 'appMenu' },
{ role: 'fileMenu' },
{ role: 'editMenu' },
{ role: 'windowMenu' },
{ role: 'help' }
]));
} else {
Menu.setApplicationMenu(null);
}
const resourcesURL = Object.assign(new URL('file://'), {
pathname: path.join(__dirname, '/')
}).href;
const defaultProjectURL = new URL('./index.html', resourcesURL).href;
const createWindow = (windowOptions) => {
const options = {
title: ${JSON.stringify(this.options.app.windowTitle)},
icon: path.resolve(__dirname, ${JSON.stringify(iconName)}),
useContentSize: true,
webPreferences: {
sandbox: true,
contextIsolation: true,
nodeIntegration: false,
},
show: true,
width: 480,
height: 360,
...windowOptions,
};
const activeScreen = screen.getDisplayNearestPoint(screen.getCursorScreenPoint());
const bounds = activeScreen.workArea;
options.x = bounds.x + ((bounds.width - options.width) / 2);
options.y = bounds.y + ((bounds.height - options.height) / 2);
const window = new BrowserWindow(options);
return window;
};
const createProjectWindow = (url) => {
const windowMode = ${JSON.stringify(this.options.app.windowMode)};
const options = {
show: false,
backgroundColor: ${JSON.stringify(this.options.appearance.background)},
width: ${this.computeWindowSize().width},
height: ${this.computeWindowSize().height},
minWidth: 50,
minHeight: 50,
};
// fullscreen === false disables fullscreen on macOS so only set this property when it's true
if (windowMode === 'fullscreen') {
options.fullscreen = true;
}
const window = createWindow(options);
if (windowMode === 'maximize') {
window.maximize();
}
window.loadURL(url);
window.show();
};
const createDataWindow = (dataURI) => {
const window = createWindow({});
window.loadURL(dataURI);
};
const isResourceURL = (url) => {
try {
const parsedUrl = new URL(url);
return parsedUrl.protocol === 'file:' && parsedUrl.href.startsWith(resourcesURL);
} catch (e) {
// ignore
}
return false;
};
const SAFE_PROTOCOLS = [
'https:',
'http:',
'mailto:',
];
const isSafeOpenExternal = (url) => {
try {
const parsedUrl = new URL(url);
return SAFE_PROTOCOLS.includes(parsedUrl.protocol);
} catch (e) {
// ignore
}
return false;
};
const isDataURL = (url) => {
try {
const parsedUrl = new URL(url);
return parsedUrl.protocol === 'data:';
} catch (e) {
// ignore
}
return false;
};
const openLink = (url) => {
if (isDataURL(url)) {
createDataWindow(url);
} else if (isResourceURL(url)) {
createProjectWindow(url);
} else if (isSafeOpenExternal(url)) {
shell.openExternal(url);
}
};
app.on('render-process-gone', (event, webContents, details) => {
const window = BrowserWindow.fromWebContents(webContents);
dialog.showMessageBoxSync(window, {
type: 'error',
title: 'Error',
message: 'Renderer process crashed: ' + details.reason + ' (' + details.exitCode + ')'
});
});
app.on('child-process-gone', (event, details) => {
dialog.showMessageBoxSync({
type: 'error',
title: 'Error',
message: details.type + ' child process crashed: ' + details.reason + ' (' + details.exitCode + ')'
});
});
app.on('web-contents-created', (event, contents) => {
contents.setWindowOpenHandler((details) => {
setImmediate(() => {
openLink(details.url);
});
return {action: 'deny'};
});
contents.on('will-navigate', (e, url) => {
if (!isResourceURL(url)) {
e.preventDefault();
openLink(url);
}
});
contents.on('before-input-event', (e, input) => {
const window = BrowserWindow.fromWebContents(contents);
if (!window || input.type !== "keyDown") return;
if (input.key === 'F11' || (input.key === 'Enter' && input.alt)) {
window.setFullScreen(!window.isFullScreen());
} else if (input.key === 'Escape' && window.isFullScreen()) {
window.setFullScreen(false);
}
});
});
app.on('session-created', (session) => {
session.webRequest.onBeforeRequest({
urls: ["file://*"]
}, (details, callback) => {
callback({
cancel: !details.url.startsWith(resourcesURL)
});
});
});
app.on('window-all-closed', () => {
app.quit();
});
app.whenReady().then(() => {
createProjectWindow(defaultProjectURL);
});
`;
zip.file(`${resourcesPrefix}${electronMainName}`, mainJS);
for (const [path, data] of Object.entries(projectZip.files)) {
setFileFast(zip, `${resourcesPrefix}${path}`, data);
}
if (isWindows) {
const readme = [
'1) Extract the whole zip',
`2) Open "${packageName}.exe" to start the app.`,
'Open "licenses.html" for information regarding open source software used by the app.',
].join('\n\n');
zip.file(`${rootPrefix}README.txt`, readme);
} else if (isMac) {
zip.file(`How to run ${this.options.app.packageName}.txt`, generateMacReadme(this.options));
const plist = this.getPlistPropertiesForPrimaryExecutable();
await this.updatePlist(zip, `${contentsPrefix}Info.plist`, plist);
// macOS Electron apps also contain several helper apps that we should update.
const HELPERS = [
'Electron Helper',
'Electron Helper (GPU)',
'Electron Helper (Renderer)',
'Electron Helper (Plugin)',
];
for (const name of HELPERS) {
await this.updatePlist(zip, `${contentsPrefix}Frameworks/${name}.app/Contents/Info.plist`, {
// In the prebuilt Electron binaries on GitHub, the original app has a CFBundleIdentifier of
// com.github.Electron and all the helpers have com.github.Electron.helper
[CFBundleIdentifier]: `${plist[CFBundleIdentifier]}.helper`,
// We shouldn't change the actual name of the helpers because we don't actually rename their .app
// We also don't rename the executable
[CFBundleDisplayName]: name.replace('Electron', this.options.app.packageName),
// electron-builder always updates the helpers to use the same version as the app itself
[CFBundleVersion]: this.options.app.version,
[CFBundleShortVersionString]: this.options.app.version,
});
}
const icns = await pngToAppleICNS(icon);
zip.file(`${contentsPrefix}Resources/electron.icns`, icns);
} else if (isLinux) {
// Some Linux distributions can't easily open the executable file from the GUI, so we'll add a simple wrapper that people can use instead.
const startScript = `#!/bin/bash
cd "$(dirname "$0")"
./${packageName}`;
zip.file(`${rootPrefix}start.sh`, startScript, {
unixPermissions: 0o100755
});
}
return zip;
}
async addWebViewMac (projectZip) {
validatePackageName(this.options.app.packageName);
const buffer = await this.fetchLargeAsset(this.options.target, 'arraybuffer');
const appZip = await (await getJSZip()).loadAsync(buffer);
// +-- WebView.app
// +-- Contents
// +-- Info.plist
// +-- MacOS
// +-- WebView (executable)
// +-- Resources
// +-- index.html
// +-- application_config.json
// +-- AppIcon.icns
const newAppName = `${this.options.app.packageName}.app`;
const contentsPrefix = `${newAppName}/Contents/`;
const resourcesPrefix = `${newAppName}/Contents/Resources/`;
const zip = new (await getJSZip());
for (const [path, data] of Object.entries(appZip.files)) {
const newPath = path
// Rename the .app itself
.replace('WebView.app', newAppName)
// Rename the executable
.replace(/WebView$/, this.options.app.packageName);
setFileFast(zip, newPath, data);
}
for (const [path, data] of Object.entries(projectZip.files)) {
setFileFast(zip, `${resourcesPrefix}${path}`, data);
}
const icon = await Adapter.getAppIcon(this.options.app.icon);
const icns = await pngToAppleICNS(icon);
zip.file(`${resourcesPrefix}AppIcon.icns`, icns);
zip.remove(`${resourcesPrefix}Assets.car`);
const parsedBackgroundColor = parseInt(this.options.appearance.background.substr(1), 16);
const applicationConfig = {
title: this.options.app.windowTitle,
background: [
// R, G, B [0-255]
parsedBackgroundColor >> 16 & 0xff,
parsedBackgroundColor >> 8 & 0xff,
parsedBackgroundColor & 0xff,
// A [0-1]
1
],
width: this.computeWindowSize().width,
height: this.computeWindowSize().height
};
zip.file(`${resourcesPrefix}application_config.json`, JSON.stringify(applicationConfig));
await this.updatePlist(zip, `${contentsPrefix}Info.plist`, this.getPlistPropertiesForPrimaryExecutable());
zip.file(`How to run ${this.options.app.packageName}.txt`, generateMacReadme(this.options));
return zip;
}
makeWebSocketProvider () {
// If using the default turbowarp.org server, we'll add a fallback for the turbowarp.xyz alias.
// This helps work around web filters as turbowarp.org can be blocked for games and turbowarp.xyz uses
// a problematic TLD. These are the same server and same variables, just different domain.
const cloudHost = this.options.cloudVariables.cloudHost === 'wss://clouddata.turbowarp.org' ? [
'wss://clouddata.turbowarp.org',
'wss://clouddata.turbowarp.xyz'
] : this.options.cloudVariables.cloudHost;
return `new Scaffolding.Cloud.WebSocketProvider(${JSON.stringify(cloudHost)}, ${JSON.stringify(this.options.projectId)})`;
}
makeLocalStorageProvider () {
return `new Scaffolding.Cloud.LocalStorageProvider(${JSON.stringify(`cloudvariables:${this.options.projectId}`)})`;
}
makeCustomProvider () {
const variables = this.options.cloudVariables.custom;
let result = '{const providers = {};\n';
for (const provider of new Set(Object.values(variables))) {
if (provider === 'ws') {
result += `providers.ws = ${this.makeWebSocketProvider()};\n`;
} else if (provider === 'local') {
result += `providers.local = ${this.makeLocalStorageProvider()};\n`;
}
}
result += 'for (const provider of Object.values(providers)) scaffolding.addCloudProvider(provider);\n';
for (const variableName of Object.keys(variables)) {
const providerToUse = variables[variableName];
result += `scaffolding.addCloudProviderOverride(${JSON.stringify(variableName)}, providers[${JSON.stringify(providerToUse)}] || null);\n`;
}
result += '}';
return result;
}
generateFilename (extension) {
return `${this.options.app.windowTitle}.${extension}`;
}
async generateGetProjectData () {
const result = [];
let getProjectDataFunction = '';
let isZip = false;
let storageProgressStart;
let storageProgressEnd;
if (this.options.target === 'html') {
isZip = this.project.type !== 'blob';
storageProgressStart = PROGRESS_FETCHED_COMPRESSED;
storageProgressEnd = PROGRESS_EXTRACTED_COMPRESSED;
const projectData = new Uint8Array(this.project.arrayBuffer);
// keep this up-to-date with base85.js
result.push(`
<script>
const getBase85DecodeValue = (code) => {
if (code === 0x28) code = 0x3c;
if (code === 0x29) code = 0x3e;
return code - 0x2a;
};
const base85decode = (str, outBuffer, outOffset) => {
const view = new DataView(outBuffer, outOffset, Math.floor(str.length / 5 * 4));
for (let i = 0, j = 0; i < str.length; i += 5, j += 4) {
view.setUint32(j, (
getBase85DecodeValue(str.charCodeAt(i + 4)) * 85 * 85 * 85 * 85 +
getBase85DecodeValue(str.charCodeAt(i + 3)) * 85 * 85 * 85 +
getBase85DecodeValue(str.charCodeAt(i + 2)) * 85 * 85 +
getBase85DecodeValue(str.charCodeAt(i + 1)) * 85 +
getBase85DecodeValue(str.charCodeAt(i))
), true);
}
};
let projectDecodeBuffer = new ArrayBuffer(${Math.ceil(projectData.length / 4) * 4});
let projectDecodeIndex = 0;
const decodeChunk = (size) => {
try {
base85decode(document.currentScript.getAttribute("data"), projectDecodeBuffer, projectDecodeIndex);
document.currentScript.remove();
projectDecodeIndex += size;
setProgress(interpolate(${PROGRESS_LOADED_SCRIPTS}, ${PROGRESS_FETCHED_COMPRESSED}, projectDecodeIndex / ${projectData.length}));
} catch (e) {
handleError(e);
}
};
</script>`);
// To avoid unnecessary padding, this should be a multiple of 4.
const CHUNK_SIZE = 1024 * 64;
for (let i = 0; i < projectData.length; i += CHUNK_SIZE) {
const projectChunk = projectData.subarray(i, i + CHUNK_SIZE);
const base85 = encode(projectChunk);
result.push(`<script data="${base85}">decodeChunk(${projectChunk.length})</script>\n`);
}
getProjectDataFunction = `() => {
const buffer = projectDecodeBuffer;
projectDecodeBuffer = null; // Allow GC
return Promise.resolve(new Uint8Array(buffer, 0, ${projectData.length}));
}`;
} else {
let src;
if (this.project.type === 'blob' || this.options.target === 'zip-one-asset') {
isZip = this.project.type !== 'blob';
src = './project.zip';
storageProgressStart = PROGRESS_FETCHED_COMPRESSED;
storageProgressEnd = PROGRESS_EXTRACTED_COMPRESSED;
} else {
src = './assets/project.json';
storageProgressStart = PROGRESS_FETCHED_PROJECT_JSON;
storageProgressEnd = PROGRESS_FETCHED_ASSETS;
}
getProjectDataFunction = `() => new Promise((resolve, reject) => {
const xhr = new XMLHttpRequest();
xhr.onload = () => {
resolve(xhr.response);
};
xhr.onerror = () => {
if (location.protocol === 'file:') {
reject(new Error('Zip environment must be used from a website, not from a file URL.'));
} else {
reject(new Error('Request to load project data failed.'));
}
};
xhr.onprogress = (e) => {
if (e.lengthComputable) {
setProgress(interpolate(${PROGRESS_LOADED_SCRIPTS}, ${storageProgressStart}, e.loaded / e.total));
}
};
xhr.responseType = 'arraybuffer';
xhr.open('GET', ${JSON.stringify(src)});
xhr.send();
})`;
}
result.push(`
<script>
const getProjectData = (function() {
const storage = scaffolding.storage;
storage.onprogress = (total, loaded) => {
setProgress(interpolate(${storageProgressStart}, ${storageProgressEnd}, loaded / total));
};
${isZip ? `
let zip;
// Allow zip to be GC'd after project loads
vm.runtime.on('PROJECT_LOADED', () => (zip = null));
const findFileInZip = (path) => zip.file(path) || zip.file(new RegExp("^([^/]*/)?" + path + "$"))[0];
storage.addHelper({
load: (assetType, assetId, dataFormat) => {
if (!zip) {
throw new Error('Zip is not loaded or has been closed');
}
const path = assetId + '.' + dataFormat;
const file = findFileInZip(path);
if (!file) {
throw new Error('Asset is not in zip: ' + path)
}
return file
.async('uint8array')
.then((data) => storage.createAsset(assetType, dataFormat, data, assetId));
}
});
return () => (${getProjectDataFunction})().then(async (data) => {
zip = await Scaffolding.JSZip.loadAsync(data);
const file = findFileInZip('project.json');
if (!file) {
throw new Error('project.json is not in zip');
}
return file.async('arraybuffer');
});` : `
storage.addWebStore(
[
storage.AssetType.ImageVector,
storage.AssetType.ImageBitmap,
storage.AssetType.Sound,
storage.AssetType.Font
].filter(i => i),
(asset) => new URL('./assets/' + asset.assetId + '.' + asset.dataFormat, location).href
);
return ${getProjectDataFunction};`}
})();
</script>`);
return result;
}
async generateFavicon () {
if (this.options.app.icon === null) {
return '';
}
const data = await Adapter.readAsURL(this.options.app.icon, 'app icon');
return `<link rel="icon" href="${data}">`;
}
async generateCursor () {
if (this.options.cursor.type !== 'custom') {
return this.options.cursor.type;
}
if (!this.options.cursor.custom) {
// Configured to use a custom cursor but no image was selected
return 'auto';
}
const data = await Adapter.readAsURL(this.options.cursor.custom, 'custom cursor');
return `url(${data}) ${this.options.cursor.center.x} ${this.options.cursor.center.y}, auto`;
}
async generateExtensionURLs () {
const dispatchProgress = (progress) => this.dispatchEvent(new CustomEvent('fetch-extensions', {
detail: {
progress
}
}));
const shouldTryToFetch = (url) => {
if (!this.options.bakeExtensions) {
return false;
}
try {
const parsed = new URL(url);
return parsed.protocol === 'http:' || parsed.protocol === 'https:';
} catch (e) {
return false;
}
};
/** @type {string[]} */
const allURLs = this.options.extensions;
const unfetchableURLs = allURLs.filter((url) => !shouldTryToFetch(url));
const urlsToFetch = allURLs.filter((url) => shouldTryToFetch(url));
const finalURLs = [...unfetchableURLs];
if (urlsToFetch.length !== 0) {
for (let i = 0; i < urlsToFetch.length; i++) {
dispatchProgress(i / urlsToFetch.length);
const url = urlsToFetch[i];
try {
const source = await Adapter.fetchExtensionScript(url);
// Wrap the extension in an IIFE so that extensions written for the sandbox are less
// likely to cause issues in an unsandboxed environment due to global pollution or
// overriding Scratch.*
const wrappedSource = `(function(Scratch) { ${source} })(Scratch);`
const dataURI = `data:text/javascript;,${encodeURIComponent(wrappedSource)}`;
finalURLs.push(dataURI);
} catch (e) {
console.warn('Could not bake extension', url, e);
finalURLs.push(url);
}
}
dispatchProgress(1);
}
return finalURLs;
}
async package () {
if (!Adapter) {
throw new Error('Missing adapter');
}
if (this.used) {
throw new Error('Packager was already used');
}
this.used = true;
this.ensureNotAborted();
await this.loadResources();
this.ensureNotAborted();
const html = encodeBigString`<!DOCTYPE html>
<!-- Created with ${WEBSITE} -->
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=no">
<!-- We only include this to explicitly loosen the CSP of various packager environments. It does not provide any security. -->
<meta http-equiv="Content-Security-Policy" content="default-src * 'self' 'unsafe-inline' 'unsafe-eval' data: blob:">
<title>${escapeXML(this.options.app.windowTitle)}</title>
<style>
body {
color: ${this.options.appearance.foreground};
font-family: sans-serif;
overflow: hidden;
margin: 0;
padding: 0;
}
:root, body.is-fullscreen {
background-color: ${this.options.appearance.background};
}
[hidden] {
display: none !important;
}
h1 {
font-weight: normal;
}
a {
color: inherit;
text-decoration: underline;
cursor: pointer;
}
#app, #loading, #error, #launch {
position: absolute;
top: 0;
left: 0;
width: 100%;
height: 100%;
}
.screen {
display: flex;
flex-direction: column;
align-items: center;
justify-content: center;
text-align: center;
cursor: default;
user-select: none;
-webkit-user-select: none;
background-color: ${this.options.appearance.background};
}
#launch {
background-color: rgba(0, 0, 0, 0.7);
cursor: pointer;
}
.green-flag {
width: 80px;
height: 80px;
padding: 16px;
border-radius: 100%;
background: rgba(255, 255, 255, 0.75);
border: 3px solid hsla(0, 100%, 100%, 1);
display: flex;
justify-content: center;
align-items: center;
box-sizing: border-box;
}
#loading {
${this.options.loadingScreen.image && this.options.loadingScreen.imageMode === 'stretch'
? `background-image: url(${await Adapter.readAsURL(this.options.loadingScreen.image, 'stretched loading screen')});
background-repeat: no-repeat;
background-size: contain;
background-position: center;`
: ''}
}
.progress-bar-outer {
border: 1px solid currentColor;
height: 10px;
width: 200px;
max-width: 200px;
}
.progress-bar-inner {
height: 100%;
width: 0;
background-color: currentColor;
}
.loading-text, noscript {
font-weight: normal;
font-size: 36px;
margin: 0 0 16px;
}
.loading-image {
margin: 0 0 16px;
}
#error-message, #error-stack {
font-family: monospace;
max-width: 600px;
white-space: pre-wrap;
user-select: text;
-webkit-user-select: text;
}
#error-stack {
text-align: left;
max-height: 200px;
overflow: auto;
}
.control-button {
width: 2rem;
height: 2rem;
padding: 0.375rem;
margin-top: 0.5rem;
margin-bottom: 0.5rem;
user-select: none;
-webkit-user-select: none;
cursor: pointer;
border: 0;
border-radius: 4px;
}
.control-button:hover {
background: ${this.options.appearance.accent}26;
}
.control-button.active {
background: ${this.options.appearance.accent}59;
}
.fullscreen-button {
background: white !important;
}
.standalone-fullscreen-button {
position: absolute;
top: 0;
right: 0;
background-color: rgba(0, 0, 0, 0.5);
border-radius: 0 0 0 4px;
padding: 4px;
cursor: pointer;
}
.sc-canvas {
cursor: ${await this.generateCursor()};
}
.sc-monitor-root[data-opcode^="data_"] .sc-monitor-value-color {
background-color: ${this.options.monitors.variableColor};
}
.sc-monitor-row-value-outer {
background-color: ${this.options.monitors.listColor};
}
.sc-monitor-row-value-editing .sc-monitor-row-value-outer {
background-color: ${darken(this.options.monitors.listColor)};
}
${this.options.custom.css}
</style>
<meta name="theme-color" content="${this.options.appearance.background}">
${await this.generateFavicon()}
</head>
<body>
<div id="app"></div>
<div id="launch" class="screen" hidden title="Click to start">
<div class="green-flag">
<svg viewBox="0 0 16.63 17.5" width="42" height="44">
<defs><style>.cls-1,.cls-2{fill:#007AF4;stroke:#003080;stroke-linecap:round;stroke-linejoin:round;}.cls-2{stroke-width:1.5px;}</style></defs>
<path class="cls-1" d="M.75,2A6.44,6.44,0,0,1,8.44,2h0a6.44,6.44,0,0,0,7.69,0V12.4a6.44,6.44,0,0,1-7.69,0h0a6.44,6.44,0,0,0-7.69,0"/>
<line class="cls-2" x1="0.75" y1="16.75" x2="0.75" y2="0.75"/>
</svg>
</div>
</div>
<div id="loading" class="screen">
<noscript>Enable JavaScript</noscript>
${this.options.loadingScreen.text ? `<h1 class="loading-text">${escapeXML(this.options.loadingScreen.text)}</h1>` : ''}
${this.options.loadingScreen.image && this.options.loadingScreen.imageMode === 'normal' ? `<div class="loading-image"><img src="${await Adapter.readAsURL(this.options.loadingScreen.image, 'loading-screen')}"></div>` : ''}
${this.options.loadingScreen.progressBar ? '<div class="progress-bar-outer"><div class="progress-bar-inner" id="loading-inner"></div></div>' : ''}
</div>
<div id="error" class="screen" hidden>
<h1>Error</h1>
<details>
<summary id="error-message"></summary>
<p id="error-stack"></p>
</details>
</div>
${this.options.target === 'html' ? `<script>${this.script}</script>` : '<script src="script.js"></script>'}
<script>${removeUnnecessaryEmptyLines(`
const appElement = document.getElementById('app');
const launchScreen = document.getElementById('launch');
const loadingScreen = document.getElementById('loading');
const loadingInner = document.getElementById('loading-inner');
const errorScreen = document.getElementById('error');
const errorScreenMessage = document.getElementById('error-message');
const errorScreenStack = document.getElementById('error-stack');
const handleError = (error) => {
console.error(error);
if (!errorScreen.hidden) return;
errorScreen.hidden = false;
errorScreenMessage.textContent = '' + error;
let debug = error && error.stack || 'no stack';
debug += '\\nUser agent: ' + navigator.userAgent;
errorScreenStack.textContent = debug;
};
const setProgress = (progress) => {
if (loadingInner) loadingInner.style.width = progress * 100 + '%';
};
const interpolate = (a, b, t) => a + t * (b - a);
try {
setProgress(${PROGRESS_LOADED_SCRIPTS});
const scaffolding = new Scaffolding.Scaffolding();
scaffolding.width = ${this.options.stageWidth};
scaffolding.height = ${this.options.stageHeight};
scaffolding.resizeMode = ${JSON.stringify(this.options.resizeMode)};
scaffolding.editableLists = ${this.options.monitors.editableLists};
scaffolding.usePackagedRuntime = ${this.options.packagedRuntime};
scaffolding.setup();
scaffolding.appendTo(appElement);
const vm = scaffolding.vm;
window.scaffolding = scaffolding;
window.vm = scaffolding.vm;
window.Scratch = {
vm,
renderer: vm.renderer,
audioEngine: vm.runtime.audioEngine,
bitmapAdapter: vm.runtime.v2BitmapAdapter,
videoProvider: vm.runtime.ioDevices.video.provider
};
scaffolding.setUsername(${JSON.stringify(this.options.username)}.replace(/#/g, () => Math.floor(Math.random() * 10)));
scaffolding.setAccentColor(${JSON.stringify(this.options.appearance.accent)});
try {
${this.options.cloudVariables.mode === 'ws' ?
`scaffolding.addCloudProvider(${this.makeWebSocketProvider()})` :
this.options.cloudVariables.mode === 'local' ?
`scaffolding.addCloudProvider(${this.makeLocalStorageProvider()})` :
this.options.cloudVariables.mode === 'custom' ?
this.makeCustomProvider() :
''
};
} catch (error) {
console.error(error);
}
${this.options.controls.greenFlag.enabled ? `
const greenFlagButton = document.createElement('img');
greenFlagButton.src = 'data:image/svg+xml,' + encodeURIComponent('<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 16.63 17.5"><path d="M.75 2a6.44 6.44 0 017.69 0h0a6.44 6.44 0 007.69 0v10.4a6.44 6.44 0 01-7.69 0h0a6.44 6.44 0 00-7.69 0" fill="#007AF4" stroke="#003080" stroke-linecap="round" stroke-linejoin="round"/><path stroke-width="1.5" fill="#007AF4" stroke="#003080" stroke-linecap="round" stroke-linejoin="round" d="M.75 16.75v-16"/></svg>');
greenFlagButton.className = 'control-button green-flag-button';
greenFlagButton.draggable = false;
greenFlagButton.addEventListener('click', () => {
scaffolding.greenFlag();
});
scaffolding.addEventListener('PROJECT_RUN_START', () => {
greenFlagButton.classList.add('active');
});
scaffolding.addEventListener('PROJECT_RUN_STOP', () => {
greenFlagButton.classList.remove('active');
});
scaffolding.addControlButton({
element: greenFlagButton,
where: 'top-left'
});` : ''}
${this.options.controls.pause.enabled ? `
const pauseButton = document.createElement('img');
pauseButton.className = 'control-button pause-button';
pauseButton.draggable = false;
let isPaused = false;
pauseButton.addEventListener('click', () => {
vm.setPaused(!isPaused);
});
const updatePause = (_isPaused) => {
isPaused = _isPaused;
if (isPaused) {
pauseButton.src = 'data:image/svg+xml,' + encodeURIComponent('<svg width="16" height="16" viewBox="0 0 4.2333332 4.2333335" xmlns="http://www.w3.org/2000/svg"><path d="m3.95163484 2.02835365-1.66643921.9621191-1.66643913.96211911V.10411543l1.66643922.9621191z" fill="#ffae00"/></svg>');
} else {
pauseButton.src = 'data:image/svg+xml,' + encodeURIComponent('<svg width="16" height="16" viewBox="0 0 4.2333332 4.2333335" xmlns="http://www.w3.org/2000/svg"><g fill="#ffae00"><path d="M.389.19239126h1.2631972v3.8485508H.389zM2.5810001.19239126h1.2631972v3.8485508H2.5810001z"/></g></svg>');
}
}
vm.on('P4_PAUSE', updatePause);
updatePause();
scaffolding.addControlButton({
element: pauseButton,
where: 'top-left'
});` : ''}
${this.options.controls.stopAll.enabled ? `
const stopAllButton = document.createElement('img');
stopAllButton.src = 'data:image/svg+xml,' + encodeURIComponent('<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 14 14"><path fill="#ec5959" stroke="#b84848" stroke-linecap="round" stroke-linejoin="round" stroke-miterlimit="10" d="M4.3.5h5.4l3.8 3.8v5.4l-3.8 3.8H4.3L.5 9.7V4.3z"/></svg>');
stopAllButton.className = 'control-button stop-all-button';
stopAllButton.draggable = false;
stopAllButton.addEventListener('click', () => {
scaffolding.stopAll();
});
scaffolding.addControlButton({
element: stopAllButton,
where: 'top-left'
});` : ''}
${this.options.controls.fullscreen.enabled ? `
if (document.fullscreenEnabled || document.webkitFullscreenEnabled) {
let isFullScreen = !!(document.fullscreenElement || document.webkitFullscreenElement);
const fullscreenButton = document.createElement('img');
fullscreenButton.draggable = false;
fullscreenButton.className = 'control-button fullscreen-button';
fullscreenButton.addEventListener('click', () => {
if (isFullScreen) {
if (document.exitFullscreen) {
document.exitFullscreen();
} else if (document.webkitExitFullscreen) {
document.webkitExitFullscreen();
}
} else {
if (document.body.requestFullscreen) {
document.body.requestFullscreen();
} else if (document.body.webkitRequestFullscreen) {
document.body.webkitRequestFullscreen();
}
}
});
const otherControlsExist = ${this.options.controls.greenFlag.enabled || this.options.controls.stopAll.enabled};
const fillColor = otherControlsExist ? '#575E75' : '${this.options.appearance.foreground}';
const updateFullScreen = () => {
isFullScreen = !!(document.fullscreenElement || document.webkitFullscreenElement);
document.body.classList.toggle('is-fullscreen', isFullScreen);
if (isFullScreen) {
fullscreenButton.src = 'data:image/svg+xml,' + encodeURIComponent('<svg width="20" height="20" xmlns="http://www.w3.org/2000/svg"><g fill="' + fillColor + '" fill-rule="evenodd"><path d="M12.662 3.65l.89.891 3.133-2.374a.815.815 0 011.15.165.819.819 0 010 .986L15.467 6.46l.867.871c.25.25.072.664-.269.664L12.388 8A.397.397 0 0112 7.611V3.92c0-.341.418-.514.662-.27M7.338 16.35l-.89-.89-3.133 2.374a.817.817 0 01-1.15-.166.819.819 0 010-.985l2.37-3.143-.87-.871a.387.387 0 01.27-.664L7.612 12a.397.397 0 01.388.389v3.692a.387.387 0 01-.662.27M7.338 3.65l-.89.891-3.133-2.374a.815.815 0 00-1.15.165.819.819 0 000 .986l2.37 3.142-.87.871a.387.387 0 00.27.664L7.612 8A.397.397 0 008 7.611V3.92a.387.387 0 00-.662-.27M12.662 16.35l.89-.89 3.133 2.374a.817.817 0 001.15-.166.819.819 0 000-.985l-2.368-3.143.867-.871a.387.387 0 00-.269-.664L12.388 12a.397.397 0 00-.388.389v3.692c0 .342.418.514.662.27"/></g></svg>');
} else {
fullscreenButton.src = 'data:image/svg+xml,' + encodeURIComponent('<svg width="20" height="20" xmlns="http://www.w3.org/2000/svg"><g fill="' + fillColor + '" fill-rule="evenodd"><path d="M16.338 7.35l-.89-.891-3.133 2.374a.815.815 0 01-1.15-.165.819.819 0 010-.986l2.368-3.142-.867-.871a.387.387 0 01.269-.664L16.612 3a.397.397 0 01.388.389V7.08a.387.387 0 01-.662.27M3.662 12.65l.89.89 3.133-2.374a.817.817 0 011.15.166.819.819 0 010 .985l-2.37 3.143.87.871c.248.25.071.664-.27.664L3.388 17A.397.397 0 013 16.611V12.92c0-.342.418-.514.662-.27M3.662 7.35l.89-.891 3.133 2.374a.815.815 0 001.15-.165.819.819 0 000-.986L6.465 4.54l.87-.871a.387.387 0 00-.27-.664L3.388 3A.397.397 0 003 3.389V7.08c0 .341.418.514.662.27M16.338 12.65l-.89.89-3.133-2.374a.817.817 0 00-1.15.166.819.819 0 000 .985l2.368 3.143-.867.871a.387.387 0 00.269.664l3.677.005a.397.397 0 00.388-.389V12.92a.387.387 0 00-.662-.27"/></g></svg>');
}
};
updateFullScreen();
document.addEventListener('fullscreenchange', updateFullScreen);
document.addEventListener('webkitfullscreenchange', updateFullScreen);
if (otherControlsExist) {
fullscreenButton.className = 'control-button fullscreen-button';
scaffolding.addControlButton({
element: fullscreenButton,
where: 'top-right'
});
} else {
fullscreenButton.className = 'standalone-fullscreen-button';
document.body.appendChild(fullscreenButton);
}
}` : ''}
vm.setTurboMode(${this.options.turbo});
if (vm.setInterpolation) vm.setInterpolation(${this.options.interpolation});
if (vm.setFramerate) vm.setFramerate(${this.options.framerate});
if (vm.renderer.setUseHighQualityRender) vm.renderer.setUseHighQualityRender(${this.options.highQualityPen});
if (vm.setRuntimeOptions) vm.setRuntimeOptions({
fencing: ${this.options.fencing},
miscLimits: ${this.options.miscLimits},
maxClones: ${this.options.maxClones},
dangerousOptimizations: ${this.options.dangerousOptimizations}
});
if (vm.setCompilerOptions) vm.setCompilerOptions({
enabled: true,
warpTimer: ${this.options.compiler.warpTimer}
});
if (vm.renderer.setMaxTextureDimension) vm.renderer.setMaxTextureDimension(${this.options.maxTextureDimension});
if (typeof ScaffoldingAddons !== 'undefined') {
ScaffoldingAddons.run(scaffolding, ${JSON.stringify(this.getAddonOptions())});
}
scaffolding.setExtensionSecurityManager({
getSandboxMode: () => 'unsandboxed',
canLoadExtensionFromProject: () => true
});
for (const extension of ${JSON.stringify(await this.generateExtensionURLs())}) {
vm.extensionManager.loadExtensionURL(extension);
}
${this.options.closeWhenStopped ? `
vm.runtime.on('PROJECT_RUN_STOP', () => {
if (!vm.isPaused || !vm.isPaused()) {
window.close();
}
});` : ''}
${this.options.penguinmod.permissionManager.enabled ? '' : `vm.runtime.isProjectPermissionManagerDisabled = true;`}
${this.options.penguinmod.permissionManager.unsandboxedJavascript ? `vm.runtime.extensionRuntimeOptions.javascriptUnsandboxed = true;` : ''}
${this.options.target.startsWith('nwjs-') ? `
if (typeof nw !== 'undefined') {
const win = nw.Window.get();
win.on('new-win-policy', (frame, url, policy) => {
policy.ignore();
nw.Shell.openExternal(url);
});
win.on('navigation', (frame, url, policy) => {
policy.ignore();
nw.Shell.openExternal(url);
});
document.addEventListener('keydown', (e) => {
if (e.key === 'Escape' && document.fullscreenElement) {
document.exitFullscreen();
}
});
}` : ''}
} catch (e) {
handleError(e);
}
`)}</script>
${this.options.custom.js ? `<script>
try {
${this.options.custom.js}
} catch (e) {
handleError(e);
}
</script>` : ''}
${await this.generateGetProjectData()}
<script>
const run = async () => {
const projectData = await getProjectData();
await scaffolding.loadProject(projectData);
setProgress(1);
loadingScreen.hidden = true;
if (${this.options.autoplay}) {
scaffolding.start();
} else {
launchScreen.hidden = false;
launchScreen.addEventListener('click', () => {
launchScreen.hidden = true;
scaffolding.start();
});
launchScreen.focus();
}
};
run().catch(handleError);
</script>
</body>
</html>
`;
this.ensureNotAborted();
if (this.options.target !== 'html') {
let zip;
if (this.project.type === 'sb3' || this.project.type === 'pm' && this.options.target !== 'zip-one-asset') {
zip = await (await getJSZip()).loadAsync(this.project.arrayBuffer);
for (const file of Object.keys(zip.files)) {
zip.files[`assets/${file}`] = zip.files[file];
delete zip.files[file];
}
} else {
zip = new (await getJSZip());
zip.file('project.zip', this.project.arrayBuffer);
}
zip.file('index.html', html);
zip.file('script.js', this.script);
if (this.options.target.startsWith('nwjs-')) {
zip = await this.addNwJS(zip);
} else if (this.options.target.startsWith('electron-')) {
zip = await this.addElectron(zip);
} else if (this.options.target === 'webview-mac') {
zip = await this.addWebViewMac(zip);
}
this.ensureNotAborted();
return {
data: await zip.generateAsync({
type: 'uint8array',
compression: 'DEFLATE',
// Use UNIX permissions so that executable bits are properly set for macOS and Linux
platform: 'UNIX'
}, (meta) => {
this.dispatchEvent(new CustomEvent('zip-progress', {
detail: {
progress: meta.percent / 100
}
}));
}),
type: 'application/zip',
filename: this.generateFilename('zip')
};
}
return {
data: html,
type: 'text/html',
filename: this.generateFilename('html')
};
}
}
Packager.getDefaultPackageNameFromFileName = (title) => {
// Note: Changing this logic is very dangerous because changing the defaults will cause already packaged projects
// to loose any data when they are updated.
title = title.split('.')[0];
title = title.replace(/[^\-a-z ]/gi, '');
title = title.trim();
title = title.replace(/ /g, '-');
return title.toLowerCase() || 'packaged-project';
};
Packager.getWindowTitleFromFileName = (title) => {
const split = title.split('.');
if (split.length > 1) {
split.pop();
}
title = split.join('.').trim();
return title || 'Packaged Project';
};
Packager.usesUnsafeOptions = (options) => {
const defaultOptions = Packager.DEFAULT_OPTIONS();
const getUnsafeOptions = (options) => [
options.custom,
options.extensions,
options.cloudVariables.unsafeCloudBehaviors
];
return JSON.stringify(getUnsafeOptions(defaultOptions)) !== JSON.stringify(getUnsafeOptions(options));
};
Packager.DEFAULT_OPTIONS = () => ({
turbo: false,
interpolation: false,
framerate: 30,
highQualityPen: false,
maxClones: 300,
fencing: true,
miscLimits: true,
dangerousOptimizations: false,
stageWidth: 480,
stageHeight: 360,
resizeMode: 'preserve-ratio',
autoplay: false,
username: 'player####',
closeWhenStopped: false,
projectId: '',
custom: {
css: '',
js: ''
},
appearance: {
background: '#000000',
foreground: '#ffffff',
accent: ACCENT_COLOR
},
loadingScreen: {
progressBar: true,
text: '',
imageMode: 'normal',
image: null
},
controls: {
greenFlag: {
enabled: false,
},
stopAll: {
enabled: false,
},
fullscreen: {
enabled: false
},
pause: {
enabled: false
}
},
monitors: {
editableLists: false,
variableColor: '#ff8c1a',
listColor: '#fc662c'
},
penguinmod: {
permissionManager: {
enabled: false,
unsandboxedJavascript: false,
},
},
compiler: {
enabled: true,
warpTimer: false
},
packagedRuntime: true,
target: 'html',
app: {
icon: null,
packageName: Packager.getDefaultPackageNameFromFileName(''),
windowTitle: Packager.getWindowTitleFromFileName(''),
windowMode: 'window',
version: '1.0.0'
},
chunks: {
gamepad: false,
pointerlock: false,
},
cloudVariables: {
mode: 'ws',
cloudHost: 'wss://clouddata.turbowarp.org',
custom: {},
specialCloudBehaviors: false,
unsafeCloudBehaviors: false,
},
cursor: {
type: 'auto',
custom: null,
center: {
x: 0,
y: 0
}
},
extensions: [],
bakeExtensions: true,
maxTextureDimension: 2048
});
export default Packager;
|